From c501d1498a8a2e3a48502419ab5dbb06d49aa4ab Mon Sep 17 00:00:00 2001 From: April Petersen Date: Mon, 6 Jan 2025 10:37:00 -0600 Subject: [PATCH] add .env file names --- readme.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 741a02c..a2f0fed 100644 --- a/readme.md +++ b/readme.md @@ -71,7 +71,7 @@ I use [LunaSea](https://www.lunasea.app/) as a mobile client for Radarr and Sona ## Environment -This configuration uses `.env` files to separate secrets from public information and keep the main `docker-compose.yml` a little shorter. +This configuration uses `.env` files to separate secrets from public information and keep the main `docker-compose.yml` a little shorter. It is set up to look for these files in `/docker/env`, with each service having its own `.env` file. Below are the variables that need to be set in the `.env` file for each service. Empty variables should be replaced with your values. @@ -99,6 +99,8 @@ Below are the variables that need to be set in the `.env` file for each service. [Docs](https://github.com/cloudflare/cloudflared?tab=readme-ov-file) ```env +# cloudflared.env + # Available in the cloudflare zero-trust tunnel dashboard, under `install and run a connector` TUNNEL_TOKEN= ``` @@ -110,6 +112,8 @@ TUNNEL_TOKEN= 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 +# gluetun.env + VPN_SERVICE_PROVIDER=mullvad VPN_TYPE=wireguard WIREGUARD_PRIVATE_KEY= @@ -126,6 +130,8 @@ The values for `WIREGUARD_PRIVATE_KEY` and `WIREGUARD_ADDRESSES` should be avail 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 +#immich.env + UPLOAD_LOCATION=/media/immich IMMICH_VERSION="v1.123.0" @@ -149,6 +155,8 @@ POSTGRES_DB=immich [Docs](https://github.com/flosoft/docker-joplin-server) ```env +# joplin.env + APP_PORT=22300 APP_BASE_URL= DB_CLIENT=pg @@ -176,6 +184,8 @@ MAILER_NOREPLY_EMAIL= This one just needs the public hostname and admin email. ```env +# linkstack.env + HTTPS_SERVER_NAME= SERVER_ADMIN= ``` @@ -185,6 +195,8 @@ SERVER_ADMIN= [Docs](https://miniflux.app/docs/docker.html) ```env +# miniflux.env + DATABASE_URL=postgres://miniflux:{...}@rss_db:5432/miniflux?sslmode=disable # replace {...} with your postgres password RUN_MIGRATIONS=1 @@ -198,6 +210,8 @@ POSTGRES_DB=miniflux [Docs](https://docs.paperless-ngx.com/setup/#docker) ```env +# paperless.env + USERMAP_UID=1000 USERMAP_GID=1000 PUID=1000 @@ -229,6 +243,8 @@ PAPERLESS_EMAIL_FROM= [Docs](https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose) ```env +# speedtest.env + PUID=1000 PGID=1000 @@ -249,6 +265,8 @@ SPEEDTEST_SCHEDULE=0,15,30,45 * * * * # run speedtest every 15 minutes [Docs](https://docs.tandoor.dev/install/docker/) ```env +# tandoor.env + # Random secret key, use for example `base64 /dev/urandom | head -c50` to generate one SECRET_KEY= @@ -275,6 +293,8 @@ These values are only required if you need to use the vaultwarden admin page (fo 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 +# vaultwarden.env + # Public domain or IP DOMAIN=