|
| 1 | +--- |
| 2 | +description: >- |
| 3 | + Speedtest Tracker can be run on a variety of platforms, the preferred platform |
| 4 | + is Docker. |
| 5 | +--- |
| 6 | + |
1 | 7 | # Installation |
2 | 8 |
|
| 9 | +These steps will run you through setting up the application using Docker and Docker Compose. |
| 10 | + |
| 11 | +### Install with Docker  |
| 12 | + |
| 13 | +Setting up your environment with Docker Compose is the recommended way as it'll setup the application and a database for you. SQLite is fine for most installs but we also provide instructions for setting up MariaDB, MySQL and Postgres should you prefer those database drivers. |
| 14 | + |
| 15 | +If you would like to provide your own SSL keys, they must be named `cert.crt` (full chain) and `cert.key` (private key), and mounted in the container folder `/config/keys`. |
| 16 | + |
| 17 | +{% hint style="info" %} |
| 18 | +Complete overview of the Environment Variables can be found [here](environment-variables.md) |
| 19 | +{% endhint %} |
| 20 | + |
| 21 | +{% tabs %} |
| 22 | +{% tab title="SQLite" %} |
| 23 | +```yaml |
| 24 | +services: |
| 25 | + speedtest-tracker: |
| 26 | + image: lscr.io/linuxserver/speedtest-tracker:latest |
| 27 | + restart: unless-stopped |
| 28 | + container_name: speedtest-tracker |
| 29 | + ports: |
| 30 | + - 8080:80 |
| 31 | + - 8443:443 |
| 32 | + environment: |
| 33 | + - PUID=1000 |
| 34 | + - PGID=1000 |
| 35 | + - APP_KEY= |
| 36 | + - DB_CONNECTION=sqlite |
| 37 | + - SPEEDTEST_SCHEDULE= # Optional |
| 38 | + - SPEEDTEST_SERVERS= # Optional |
| 39 | + - DATETIME_FORMAT= |
| 40 | + - APP_TIMEZONE= |
| 41 | + volumes: |
| 42 | + - /path/to/data:/config |
| 43 | + - /path/to-custom-ssl-keys:/config/keys |
| 44 | + |
| 45 | +``` |
| 46 | +{% endtab %} |
| 47 | + |
| 48 | +{% tab title="MariaDB/MySQL" %} |
| 49 | +```yaml |
| 50 | +services: |
| 51 | + speedtest-tracker: |
| 52 | + container_name: speedtest-tracker |
| 53 | + ports: |
| 54 | + - 8080:80 |
| 55 | + - 8443:443 |
| 56 | + environment: |
| 57 | + - PUID=1000 |
| 58 | + - PGID=1000 |
| 59 | + - APP_KEY= |
| 60 | + - DB_CONNECTION=mysql |
| 61 | + - DB_HOST=db |
| 62 | + - DB_PORT=3306 |
| 63 | + - DB_DATABASE=speedtest_tracker |
| 64 | + - DB_USERNAME=speedy |
| 65 | + - DB_PASSWORD=password |
| 66 | + - SPEEDTEST_SCHEDULE= |
| 67 | + - SPEEDTEST_SERVERS= |
| 68 | + - PRUNE_RESULTS_OLDER_THAN= |
| 69 | + - CHART_DATETIME_FORMAT= |
| 70 | + - DATETIME_FORMAT= |
| 71 | + - APP_TIMEZONE= |
| 72 | + volumes: |
| 73 | + - /path/to/data:/config |
| 74 | + - /path/to-custom-ssl-keys:/config/keys |
| 75 | + image: lscr.io/linuxserver/speedtest-tracker:latest |
| 76 | + restart: unless-stopped |
| 77 | + depends_on: |
| 78 | + - db |
| 79 | + db: |
| 80 | + image: mariadb:10 |
| 81 | + restart: always |
| 82 | + environment: |
| 83 | + - MARIADB_DATABASE=speedtest_tracker |
| 84 | + - MARIADB_USER=speedy |
| 85 | + - MARIADB_PASSWORD=password |
| 86 | + - MARIADB_RANDOM_ROOT_PASSWORD=true |
| 87 | + volumes: |
| 88 | + - speedtest-db:/var/lib/mysql |
| 89 | +volumes: |
| 90 | + speedtest-db: |
| 91 | +``` |
| 92 | +{% endtab %} |
| 93 | +
|
| 94 | +{% tab title="Postgres" %} |
| 95 | +```yaml |
| 96 | +services: |
| 97 | + speedtest-tracker: |
| 98 | + container_name: speedtest-tracker |
| 99 | + ports: |
| 100 | + - 8080:80 |
| 101 | + - 8443:443 |
| 102 | + environment: |
| 103 | + - PUID=1000 |
| 104 | + - PGID=1000 |
| 105 | + - APP_KEY= |
| 106 | + - DB_CONNECTION=pgsql |
| 107 | + - DB_HOST=db |
| 108 | + - DB_PORT=5432 |
| 109 | + - DB_DATABASE=speedtest_tracker |
| 110 | + - DB_USERNAME=speedy |
| 111 | + - DB_PASSWORD=password |
| 112 | + - SPEEDTEST_SCHEDULE= |
| 113 | + - SPEEDTEST_SERVERS= |
| 114 | + - PRUNE_RESULTS_OLDER_THAN= |
| 115 | + - CHART_DATETIME_FORMAT= |
| 116 | + - DATETIME_FORMAT= |
| 117 | + - APP_TIMEZONE= |
| 118 | + volumes: |
| 119 | + - /path/to/data:/config |
| 120 | + - /path/to-custom-ssl-keys:/config/keys |
| 121 | + image: lscr.io/linuxserver/speedtest-tracker:latest |
| 122 | + restart: unless-stopped |
| 123 | + depends_on: |
| 124 | + - db |
| 125 | + db: |
| 126 | + image: postgres:17 |
| 127 | + restart: always |
| 128 | + environment: |
| 129 | + - POSTGRES_DB=speedtest_tracker |
| 130 | + - POSTGRES_USER=speedy |
| 131 | + - POSTGRES_PASSWORD=password |
| 132 | + volumes: |
| 133 | + - speedtest-db:/var/lib/postgresql/data |
| 134 | +volumes: |
| 135 | + speedtest-db: |
| 136 | +``` |
| 137 | +{% endtab %} |
| 138 | +{% endtabs %} |
| 139 | +
|
| 140 | +The following environment variables need to be set: `APP_TIMEZONE`, `DATETIME_FORMAT`, and `APP_KEY`. Instructions on how to set them can be found [here](environment-variables.md). |
| 141 | + |
| 142 | +### Install with Kubernetes |
| 143 | + |
| 144 | +Check out this amazing community kubernetes manifest to get you started. |
| 145 | + |
| 146 | +{% embed url="https://github.com/maximemoreillon/kubernetes-manifests/tree/master/speedtest-tracker" %} |
0 commit comments