From c1ce4eda5242cef62a1428253a929b0a5fab8174 Mon Sep 17 00:00:00 2001 From: April Petersen Date: Mon, 6 Jan 2025 10:17:47 -0600 Subject: [PATCH] add more documentation links --- readme.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/readme.md b/readme.md index 29bac98..d6de9bd 100644 --- a/readme.md +++ b/readme.md @@ -100,7 +100,9 @@ Below are the variables that need to be set in the `.env` file for each service. ### gluetun -The values below are specific to Mullvad VPN ([docs](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)). Other providers need different values, refer to the corresponding gluetun documentation. +[Docs](https://github.com/qdm12/gluetun) + +The values below are specific to Mullvad VPN ([gluetun docs](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)). Other providers need different values, refer to the corresponding gluetun documentation. ```env VPN_SERVICE_PROVIDER=mullvad @@ -114,9 +116,9 @@ The values for `WIREGUARD_PRIVATE_KEY` and `WIREGUARD_ADDRESSES` should be avail ### Immich -My current Immich docker setup includes a lot of repetition - when I want to update, I have to change the version in 3 places. I have plans to improve this, but for now this is what works. Also note that the way I set the upload location is not recommended by the Immich docs. +[Docs](https://immich.app/docs/install/docker-compose/) -For more information, see the Immich [docker-compose setup instructions](https://immich.app/docs/install/docker-compose/). +My current Immich docker setup has a lot of repetition - when I want to update, I have to change the version in 3 places. I have plans to improve this, but for now this is what works. Also note that the way I set the upload location is not recommended by the Immich docs. ```env UPLOAD_LOCATION=/media/immich @@ -139,7 +141,7 @@ POSTGRES_DB=immich ### Joplin -See the [docker-joplin-server docs](https://github.com/flosoft/docker-joplin-server) for more info. +[Docs](https://github.com/flosoft/docker-joplin-server) ```env APP_PORT=22300 @@ -151,7 +153,7 @@ POSTGRES_USER= POSTGRES_PORT=5432 POSTGRES_HOST=joplin-db -# Optional SMTP options +# Optional SMTP settings MAILER_ENABLED=1 MAILER_HOST= MAILER_PORT=465 @@ -164,7 +166,9 @@ MAILER_NOREPLY_EMAIL= ### LinkStack -This one just needs the public hostname and admin email. [Docs](https://linkstack.org/docker/). +[Docs](https://linkstack.org/docker/) + +This one just needs the public hostname and admin email. ```env HTTPS_SERVER_NAME= @@ -217,13 +221,18 @@ PAPERLESS_EMAIL_FROM= ### Speedtest Tracker -[Docs](https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose). `APP_URL` is the public address, `APP_KEY` is generated with `echo -n 'base64:'; openssl rand -base64 32;` +[Docs](https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose) ```env PUID=1000 PGID=1000 + +# Generate with `echo -n 'base64:'; openssl rand -base64 32;` or use the speedtest-tracker website APP_KEY= + +# Public address or IP APP_URL= + DB_CONNECTION=sqlite APP_TIMEZONE= DISPLAY_TIMEZONE= @@ -232,7 +241,7 @@ SPEEDTEST_SCHEDULE=0,15,30,45 * * * * # run speedtest every 15 minutes ### Tandoor -[Docs](https://docs.tandoor.dev/install/docker/). +[Docs](https://docs.tandoor.dev/install/docker/) ```env # Random secret key, use for example `base64 /dev/urandom | head -c50` to generate one @@ -252,16 +261,18 @@ POSTGRES_PASSWORD= ### vaultwarden -[Docs](https://github.com/dani-garcia/vaultwarden). Note that the crypto API requires HTTPS, so local access is a bit of a challenge. +[Docs](https://github.com/dani-garcia/vaultwarden) + +Note that the cryptography API used by vaultwarden requires HTTPS, so local access can be a bit of a challenge. These values are only required if you need to use the vaultwarden admin page (for user management, SMTP, hardware 2FA, etc.). The `ADMIN_TOKEN` value gave me trouble - to make it work, I used the 'Using `argon2`' instructions from [Enabling admin page](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page) in the docs. At `your-ip-or-url.com/admin`, the password you used for the hash will unlock it (e.g. `MySecretPassword` per their example). Note: The `ADMIN_TOKEN` value should be enclosed in single quotes. If it is not, all instances of `$` in the value will need to be replaced with `$$` to prevent the value from being split by the parser. ```env +# Public domain or IP DOMAIN= -# Dollar signs must be replaced with two dollar signs to properly escape variables in this token ADMIN_TOKEN= # Optional SMTP email settings