Merge pull request alexjustesen#46 from svenvg93/env

Add Examples for environment variables & Tailscale Config

Author: alexjustesen

SUMMARY.md

@@ -39,6 +39,7 @@
 * [Proxies](other/proxies/README.md)
   * [Cloudflare Tunnel (Zero Trust)](other/proxies/cloudflare-tunnel-zero-trust.md)
   * [Traefik](other/proxies/traefik.md)
+  * [Tailscale](other/proxies/tailscale.md)
 * [Caching](other/caching.md)
 * [Commands](other/commands.md)
 * [Data Dictionary](other/data-dictionary.md)

getting-started/environment-variables.md

@@ -8,8 +8,8 @@ description: >-
 
 ### Application
 
-<table><thead><tr><th width="233">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>Used to define the application's name in the dashboard and in notifications.<br></td></tr><tr><td><code>APP_KEY</code><br><br>(required)</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td></tr><tr><td><code>APP_URL</code></td><td>URL used for links in emails and notifications.</td></tr><tr><td><code>ASSET_URL</code></td><td>URL used for assets, needed when using a reverse proxy.</td></tr><tr><td><code>APP_TIMEZONE</code></td><td>Application timezone should be set if your database does not use UTC as it's default timezone.</td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>Display timestamps in your local time.</td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>Width of the content section of each page. Can be set to any value found in the Filament <a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>Frequency data refreshes in the results table. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>false</code></td></tr></tbody></table>
+<table><thead><tr><th width="218">Name</th><th width="103" data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>PUID</code></td><td>true</td><td>Used to set the user the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>PGID</code></td><td>true</td><td>Used to set the group the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>false</td><td>Used to define the application's name in the dashboard and in notifications.<br></td><td></td></tr><tr><td><code>APP_KEY</code></td><td>true</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td><td><code>base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=</code><br>(DONT USE THIS EXAMPLE)</td></tr><tr><td><code>APP_URL</code></td><td>false</td><td>URL used for links in emails and notifications.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>ASSET_URL</code></td><td>false</td><td>URL used for assets, needed when using a reverse proxy.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>APP_TIMEZONE</code></td><td>false</td><td>Application timezone should be set if your database does not use UTC as it's default timezone.</td><td><code>Europe/London</code></td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>false</td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j/m G:i</code><br>(18/10 20:06)</td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>false</td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j M Y, G:i:s</code><br>(18 Oct 2024, 20:06:01)</td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>false</td><td>Display timestamps in your local time.</td><td><code>Europe/London</code></td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>false</td><td>Width of the content section of each page. Can be set to any value found in the Filament <a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td><td></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>false</td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td><td></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>false</td><td>Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td><td></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>false</td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td><td></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>false</td><td>Frequency data refreshes in the results table. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>false</code></td><td></td></tr></tbody></table>
 
 ### Speedtest
 
-<table><thead><tr><th width="226">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>SPEEDTEST</code><br><code>_PING_URL</code></td><td>IP address or URL used to check for an internet connection prior to running a test.</td></tr><tr><td><code>SPEEDTEST</code><br><code>_SCHEDULE</code></td><td>Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool.</td></tr><tr><td><code>SPEEDTEST</code><br><code>_SERVERS</code></td><td>Comma separated list of server IDs to randomly use for speedtests, use this page to find the best servers for your ISP/location https://c.speedtest.net/speedtest-servers-static.php.</td></tr><tr><td><code>PRUNE_RESULTS</code><br><code>_OLDER_THAN</code></td><td>Set the value to greated than zero to prune stored results. This value should be represented in days, e.g. <code>7</code> will purge all results over 7 days old.</td></tr></tbody></table>
+<table><thead><tr><th width="221">Name</th><th data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>SPEEDTEST</code><br><code>_PING_URL</code></td><td>false</td><td>IP address or URL used to check for an internet connection prior to running a test.</td><td><code>1.1.1.1</code></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SCHEDULE</code></td><td>false</td><td>Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool.</td><td><code>6 */2 * * *</code><br>(<em>At minute 6 past every 2nd hour)</em></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SERVERS</code></td><td>false</td><td>Comma separated list of server IDs to randomly use for speedtests, use this page to find the best servers for your ISP/location https://c.speedtest.net/speedtest-servers-static.php.</td><td><code>52365</code> or <code>36998,52365</code></td></tr><tr><td><code>PRUNE_RESULTS</code><br><code>_OLDER_THAN</code></td><td>false</td><td>Set the value to greated than zero to prune stored results. This value should be represented in days, e.g. <code>7</code> will purge all results over 7 days old.</td><td><code>7</code></td></tr></tbody></table>

other/proxies/cloudflare-tunnel-zero-trust.md

@@ -8,7 +8,7 @@
 * For the tunnel you want to add the Speedtest Tracker to. Click on **Edit**
 * Go to **Public Hostname**
 * Click on **Add a public hostname**
-* Fill in the fields the following field 
+* Fill in the fields the following field
   * **Subdomain:** The subdomain you want to access the Speedtest Tracker on.
   * **Domain:** The domain you want to access the Speedtest Tracker on.
   * **Type:** Connection type to the Speedtest Tracker (http/https)
@@ -21,8 +21,6 @@ When using the container\_name Cloudflare Tunnel and Speedtest Tracker need to b
 
 <figure><img src="../../.gitbook/assets/cf-tunnel.png" alt=""><figcaption></figcaption></figure>
 
-
-
 ### Docker Configuration
 
 Docker-Compose:
@@ -34,12 +32,16 @@ services:
         environment:
             - PUID=1000
             - PGID=1000
-            - DB_CONNECTION=sqlite
             - APP_KEY=
-            - ASSET_URL=
+            - DB_CONNECTION=sqlite
             - SPEEDTEST_SCHEDULE=
             - SPEEDTEST_SERVERS=
+            - PRUNE_RESULTS_OLDER_THAN=
+            - CHART_DATETIME_FORMAT= 
+            - DATETIME_FORMAT=
+            - APP_TIMEZONE=
             - APP_URL=speedtest.yourdomain.com # Change this to your domain name
+            - ASSET_URL=speedtest.yourdomain.com # Change this to your domain name
         volumes:
             - /path/to/data:/config
             - /path/to-custom-ssl-keys:/config/keys
@@ -48,7 +50,7 @@ services:
 ```
 
 {% hint style="info" %}
-Depending on your Cloudflare Tunnel configuration, you need to make use the Speedtest Tracker and Cloudflare Tunnel  are on the same docker network.
+Depending on your Cloudflare Tunnel configuration, you need to make sure the Speedtest Tracker and Cloudflare Tunnel are on the same docker network.
 {% endhint %}
 
 <table><thead><tr><th width="291">Added compose part</th><th>Description</th></tr></thead><tbody><tr><td><code>APP_URL</code></td><td>URL you want to access the WebGui on.</td></tr><tr><td><code>ASSET_URL</code></td><td>URL used for loading all the needed assets. Need to be the same as the <code>APP_URL</code>.</td></tr></tbody></table>

other/proxies/tailscale.md

@@ -0,0 +1,67 @@
+# Tailscale
+
+[Tailscale](https://tailscale.com) Mesh VPN service can be used as an sidecar container to access the Speedtest Tracker within your Tailnet on its own MagicDNS name. 
+
+## Tailscale Auth key 
+
+Generate an auth key for tailscale so the docker container can access your tailnet.
+
+1. Open the [**Keys**](https://login.tailscale.com/admin/settings/keys) page of the admin console.
+2. Select **Generate auth key**.
+3. Fill out the form fields to specify characteristics about the auth key, such as the description, whether its reusable, when it expires, and device settings.
+4. Select **Generate key**.
+
+Save this Auth Key. We will need this later on.
+
+## Docker Configuration
+
+Docker-Compose:
+
+```yaml
+services:
+  tailscale-speedtest:
+    image: tailscale/tailscale
+    container_name: tailscale_speedtest-tracker
+    hostname: speedtest
+    environment:
+      - TS_AUTHKEY=
+      - TS_STATE_DIR=/var/lib/tailscale
+      - TS_USERSPACE=false
+    volumes:
+      - ./tailscale-traefik/state:/var/lib/tailscale
+      - /dev/net/tun:/dev/net/tun
+    cap_add:
+      - net_admin
+      - sys_module
+    restart: unless-stopped
+
+  speedtest-tracker:
+    container_name: speedtest-tracker-tailscale
+    depends_on:
+      - tailscale-speedtest
+    network_mode: service:tailscale-speedtest
+    environment:
+        - PUID=1000
+        - PGID=1000
+        - APP_KEY=
+        - DB_CONNECTION=sqlite
+        - SPEEDTEST_SCHEDULE=
+        - SPEEDTEST_SERVERS=
+        - PRUNE_RESULTS_OLDER_THAN=
+        - CHART_DATETIME_FORMAT= 
+        - DATETIME_FORMAT=
+        - APP_TIMEZONE=
+        - APP_URL=speedtest.yourtailnet.ts.net # Change this to your MagicDNS name
+        - ASSET_URL=speedtest.yourtailnet.ts.net # Change this to your MagicDNS name
+    volumes:
+        - /path/to/data:/config
+        - /path/to-custom-ssl-keys:/config/keys
+    image: lscr.io/linuxserver/speedtest-tracker:latest
+    restart: unless-stopped
+```
+
+| Added compose part | Description                                                                             |
+| ------------------ | --------------------------------------------------------------------------------------- |
+| `APP_URL`          | URL you want to access the WebGui on. This will need to be the Tailscale Magic DNS name |
+| `ASSET_URL`        | URL used for loading all the needed assets. Need to be the same as the `APP_URL`.       |
+| `TS_AUTHKEY`       | Auth key for Tailscale                                                                  |

other/proxies/traefik.md

@@ -11,12 +11,16 @@ services:
         environment:
             - PUID=1000
             - PGID=1000
-            - DB_CONNECTION=sqlite
             - APP_KEY=
-            - ASSET_URL=
+            - DB_CONNECTION=sqlite
             - SPEEDTEST_SCHEDULE=
             - SPEEDTEST_SERVERS=
+            - PRUNE_RESULTS_OLDER_THAN=
+            - CHART_DATETIME_FORMAT= 
+            - DATETIME_FORMAT=
+            - APP_TIMEZONE=
             - APP_URL=speedtest.yourdomain.com # Change this to your domain name
+            - ASSET_URL=speedtest.yourdomain.com # Change this to your domain name
         volumes:
             - /path/to/data:/config
             - /path/to-custom-ssl-keys:/config/keys
@@ -32,7 +36,7 @@ services:
 ```
 
 {% hint style="info" %}
-Depending on your Traefik configuration, you need to make use the Speedtest Tracker and Traefik are on the same docker network.
+Depending on your Traefik configuration, you need to make sure the Speedtest Tracker and Traefik are on the same docker network.
 {% endhint %}
 
 <table><thead><tr><th width="291">Added compose part</th><th>Description</th></tr></thead><tbody><tr><td><code>APP_URL</code></td><td>URL you want to access the WebGui on.</td></tr><tr><td><code>ASSET_URL</code></td><td>URL used for loading all the needed assets. Need to be the same as the <code>APP_URL</code>.</td></tr><tr><td><code>traefik.enable=true</code></td><td>Explicitly tell Traefik to expose this container</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.rule=Host(`speedtest.yourdomain.com`)</code></td><td>The domain the service will respond to</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.entrypoints=websecure</code></td><td>Allow request only from the predefined entry point</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls=true</code></td><td>When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolver</code></td><td>Explicitly tell Traefik which Certificate provider to use matching your Traefik configuration</td></tr><tr><td><code>traefik.http.services.speedtest-tracker.loadbalancer.server.port=80</code></td><td>Explicitly tell Traefik port to use to connect to the container</td></tr></tbody></table>