GitBook: [alexjustesen#8] No subject

Author: alexjustesen

README.md

@@ -6,6 +6,10 @@ description: >-
 
 # 🐇 Speedtest Tracker
 
+{% hint style="info" %}
+These docs are up-to-date for version `0.1.0-alpha7`
+{% endhint %}
+
 {% hint style="warning" %}
 Speedtest Tracker is in active development, during this "alpha" phase expect things to change and maybe break.
 {% endhint %}
@@ -19,4 +23,4 @@ Speedtest Tracker runs a speedtest check against Ookla's Speedtest service on a
 * Scheduled speedtest
 * Ad-hoc speedtest
 * Specify a speedtest server or use the default "closest" server
-* Store results to your database of choice `sqlite`, `mariadb/mysql` or `postgresql`
+* Store results to your database of choice `sqlite`, `mariadb` / `mysql` or `postgresql`

getting-started/authentication.md

@@ -2,7 +2,9 @@
 
 Speedtest Tracker uses Filament for the admin panel. During the install process an admin account is created for you.
 
-Use `[email protected]` and `password` to log into the admin panel.
+| Username            | Password   |
+| ------------------- | ---------- |
+| `[email protected]` | `password` |
 
 {% hint style="info" %}
 A process for changing the admin account's email address and password is planned.

getting-started/installation.md

@@ -1,5 +1,12 @@
 # Installation
 
+### Required Configuration
+
+| Variable | Default Value | Description                                   |
+| -------- | ------------- | --------------------------------------------- |
+| PUID     | 1000          | Update with your UID by running `id username` |
+| PGID     | 1000          | Update with your GID by running `id username` |
+
 ### Install with Docker
 
 {% hint style="info" %}
@@ -9,44 +16,45 @@ MariaDB/MySQL and PostgreSQL instructions assumes you have a database instance t
 {% tabs %}
 {% tab title="Docker (Sqlite)" %}
 ```bash
-docker run -itd --name speedtest-tracker \
-    -p 8080:80 \
-    -e "PHP_POOL_NAME=speedtest-tracker_php" \
-    -e "DB_CONNECTION=sqlite" \
-    -e "DB_DATABASE=/app/database.sqlite" \
-    -v /path/to/directory:/app \
+docker run -d --name speedtest-tracker \
+    -p 8443:443 \
+    -e PUID=1000 \ 
+    -e PGID=1000 \
+    -v /path/to/directory:/config \
     ghcr.io/alexjustesen/speedtest-tracker:latest
 ```
 {% endtab %}
 
 {% tab title="Docker (MariaDB/MySQL)" %}
 ```bash
-docker run -itd --name speedtest-tracker \
-    -p 8080:80 \
-    -e "PHP_POOL_NAME=speedtest-tracker_php" \
+docker run -d --name speedtest-tracker \
+    -p 8443:443 \
+    -e PUID=1000 \ 
+    -e PGID=1000 \
     -e "DB_CONNECTION=mysql" \
     -e "DB_HOST=" \
     -e "DB_PORT=3306" \
     -e "DB_DATABASE=speedtest_tracker" \
     -e "DB_USERNAME=" \
     -e "DB_PASSWORD=" \
-    -v /path/to/directory:/app \
+    -v /path/to/directory:/config \
     ghcr.io/alexjustesen/speedtest-tracker:latest
 ```
 {% endtab %}
 
 {% tab title="Docker (PostgreSQL)" %}
 ```bash
-docker run -itd --name speedtest-tracker \
-    -p 8080:80 \
-    -e "PHP_POOL_NAME=speedtest-tracker_php" \
+docker run -d --name speedtest-tracker \
+    -p 8443:443 \
+    -e PUID=1000 \ 
+    -e PGID=1000 \
     -e "DB_CONNECTION=pgsql" \
     -e "DB_HOST=" \
     -e "DB_PORT=5432" \
     -e "DB_DATABASE=speedtest_tracker" \
     -e "DB_USERNAME=" \
     -e "DB_PASSWORD=" \
-    -v /path/to/directory:/app \
+    -v /path/to/directory:/config \
     ghcr.io/alexjustesen/speedtest-tracker:latest
 ```
 {% endtab %}