Documentation + refactoring and edit sample files

.env.custom.sample

@@ -27,7 +27,25 @@
 ###################### OTHER APPS VARIABLES #####################
 #################################################################
 
-# DELUGE_CUSTOM_ENVIRONMENT_VARIABLE=exemple_value
+# Calibre admin password
+CALIBRE_CALIBRE_PASSWORD=changeme
+
+# Flood Password for Deluge RPC daemon
+FLOOD_FLOOD_PASSWORD=changeme
+
+# Please ensure you encrypt your password first using this command:
+# docker run -it --rm --entrypoint htpasswd ubuntu/apache2 -nbB admin your_password | cut -d ":" -f 2 | sed -e s/\\$/\\$\\$/g
+PORTAINER_PORTAINER_ADMIN_PASSWORD=changeme
+
+# Nextcloud
+NEXTCLOUD_NEXTCLOUD_ADMIN_USER=admin # you can change it
+NEXTCLOUD_NEXTCLOUD_ADMIN_PASSWORD=changeme
+
+# Nextcloud DB (mariadb)
+MARIADB_MYSQL_ROOT_PASSWORD=changeme
+MARIADB_MYSQL_DATABASE=nextcloud
+MARIADB_MYSQL_USER=nextcloud
+MARIADB_MYSQL_PASSWORD=changeme
 
 #################################################################
 ############# PAPERLESS CUSTOM ENVIRONMENT VARIABLES ############
@@ -40,4 +58,19 @@ PAPERLESS_PAPERLESS_ADMIN_USER=admin
 [email protected]
 PAPERLESS_PAPERLESS_ADMIN_PASSWORD=clear_password_changeme1234
 # Prevent errors when importing PDF files with digital signatures
-PAPERLESS_PAPERLESS_OCR_USER_ARGS="{\"invalidate_digital_signatures\": true}"
+PAPERLESS_PAPERLESS_OCR_USER_ARGS="{\"invalidate_digital_signatures\": true}"
+
+#################################################################
+############## GLUETUN CUSTOM ENVIRONMENT VARIABLES #############
+#################################################################
+
+# Wireguard custom endpoint
+GLUETUN_VPN_SERVICE_PROVIDER=custom
+GLUETUN_VPN_TYPE=wireguard
+
+GLUETUN_VPN_ENDPOINT_IP=changeme # Wireguard endpoint
+GLUETUN_VPN_ENDPOINT_PORT=51820
+GLUETUN_WIREGUARD_PUBLIC_KEY=changeme
+GLUETUN_WIREGUARD_PRIVATE_KEY=changeme
+GLUETUN_WIREGUARD_PRESHARED_KEY=changeme # optional
+GLUETUN_WIREGUARD_ADDRESSES=changeme # Wireguard LAN address

.env.sample

@@ -7,11 +7,6 @@ DOCKER_COMPOSE_BINARY="docker compose" # or "docker-compose"
 TRAEFIK_DOMAIN=mydomain.com
 ACME_MAIL=[email protected]
 
-# Custom resolver for Traefik / ACME (override existing httpChallenge)
-# You also have to use .env.custom by copying .env.custom.sample and uncomment / edit appropriate variables first
-# See list here: https://go-acme.github.io/lego/dns/#dns-providers
-# TRAEFIK_CUSTOM_ACME_RESOLVER="changeme" # example "cloudflare" or "ovh"
-
 # General settings
 TZ="Europe/Paris"
 
@@ -22,9 +17,11 @@ HTTP_USER=myuser
 HTTP_PASSWORD='mypassword_encoded' # Keep these simple quotes!
 
 # Host paths + containers permissions mapping
+# Default = "/data/config"
 HOST_CONFIG_PATH="/data/config"
+# Default = "/data/torrents"
 HOST_MEDIA_PATH="/data/torrents"
-# Will be located in $HOST_MEDIA_PATH
+# Default = "deluge". Will be located in $HOST_CONFIG_PATH
 DOWNLOAD_SUBFOLDER="deluge"
 DOCUMENTS_SUBFOLDER="documents"
 
@@ -34,43 +31,18 @@ NFS_MEDIA_VOLUME=":/volume1/homes/youruser/media"
 # NFS Server IP
 NFS_IP="192.168.0.XXX"
 
-# PGID and PUID of the disk permissions
-PGID=1000
+# Filesystem permissions
+# PUID and PGID of the disk permissions
 PUID=1000
+PGID=1000
 
-# Database (for Nextcloud)
-MYSQL_ROOT_PASSWORD=changeme
-MYSQL_DATABASE=nextcloud
-MYSQL_USER=nextcloud
-MYSQL_PASSWORD=changeme
-
-# Nextcloud
-NEXTCLOUD_ADMIN_USER=admin # you can change it
-NEXTCLOUD_ADMIN_PASSWORD=changeme
+#################################################################################
+################# Various seedbox's autoconfiguration variables #################
+#################################################################################
 
-# Portainer
-# Please ensure you encrypt your password first using this command:
-# docker run -it --rm --entrypoint htpasswd ubuntu/apache2 -nbB admin your_password | cut -d ":" -f 2 | sed -e s/\\$/\\$\\$/g
-PORTAINER_ADMIN_PASSWORD=changeme
+# Custom resolver for Traefik / ACME (override existing httpChallenge)
+# You also have to use .env-custom by copying .env-custom.sample and uncomment / edit appropriate variables first
+# See list here: https://go-acme.github.io/lego/dns/#dns-providers
+# TRAEFIK_CUSTOM_ACME_RESOLVER="changeme" # example "cloudflare" or "ovh"
 
-# Flood username declared in  deluge RPC daemon
-FLOOD_PASSWORD=changeme # Flood Password for Deluge RPC daemon
 FLOOD_AUTOCREATE_USER_IN_DELUGE_DAEMON=false
-
-CALIBRE_PASSWORD=mycalibrepassword
-
-# Paperless
-PAPERLESS_SECRET_KEY=changeme
-# list of language codes here: https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
-PAPERLESS_OCR_LANGUAGE=eng
-PAPERLESS_ADMIN_USER=changeme
-PAPERLESS_ADMIN_MAIL=changeme
-PAPERLESS_ADMIN_PASSWORD=changeme
-
-# Wireguard custom endpoint
-WIREGUARD_ENDPOINT=changeme # Wireguard endpoint
-WIREGUARD_PORT=51820
-WIREGUARD_PUBLIC_KEY=changeme
-WIREGUARD_PRIVATE_KEY=changeme
-WIREGUARD_ADDRESS=changeme # Wireguard LAN address
-WIREGUARD_PRESHARED_KEY=changeme # optional

.gitignore

@@ -19,5 +19,7 @@ services/generated/*.yaml
 authelia/*
 .env.custom
 *.env
+env/*
+env
 
 docker-compose.yaml