Merge pull request #60 from jfroment/dev

v2.2 - The Flame 🔥

Author: jfroment

.env.custom.sample

@@ -0,0 +1,76 @@
+#################################################################
+################## CUSTOM ENVIRONMENT VARIABLES #################
+#################################################################
+
+# How to use:
+# Copy this file first and name it ".env.custom"
+# Uncomment *ONLY* the variables you want to use (!!! Always use the prefix APPNAME_)
+# Set their values
+
+#################################################################
+############## TRAEFIK CUSTOM CERTIFICATE RESOLVER ##############
+#################################################################
+
+# Add your own by finding the variables for your provider here: https://go-acme.github.io/lego/dns/#dns-providers
+
+########################## Cloudflare ###########################
+# TRAEFIK_CF_API_EMAIL=changeme
+# TRAEFIK_CF_API_KEY=changeme
+############################## OVH ##############################
+# TRAEFIK_OVH_ENDPOINT=changeme
+# TRAEFIK_OVH_APPLICATION_KEY=changeme
+# TRAEFIK_OVH_APPLICATION_SECRET=changeme
+# TRAEFIK_OVH_CONSUMER_KEY=changeme
+############################## ... ##############################
+
+#################################################################
+###################### OTHER APPS VARIABLES #####################
+#################################################################
+
+# 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 ############
+#################################################################
+
+PAPERLESS_PAPERLESS_SECRET_KEY=mykey
+# list of language codes here: https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
+PAPERLESS_PAPERLESS_OCR_LANGUAGE=eng,fra
+PAPERLESS_PAPERLESS_ADMIN_USER=admin
+PAPERLESS_PAPERLESS_ADMIN_MAIL=yourmail@domain.com
+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}"
+
+#################################################################
+############## 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

@@ -17,37 +17,32 @@ 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"
-PGID=1000
-PUID=1000
+DOCUMENTS_SUBFOLDER="documents"
 
-# Database (for Nextcloud)
-MYSQL_ROOT_PASSWORD=changeme
-MYSQL_DATABASE=nextcloud
-MYSQL_USER=nextcloud
-MYSQL_PASSWORD=changeme
+### NFS FOR MEDIA (only required if custom docker-compose file from sample/ directory is used)
+# Volume share - beware of the starting ":"
+NFS_MEDIA_VOLUME=":/volume1/homes/youruser/media"
+# NFS Server IP
+NFS_IP="192.168.0.XXX"
 
-# Nextcloud
-NEXTCLOUD_ADMIN_USER=admin # you can change it
-NEXTCLOUD_ADMIN_PASSWORD=changeme
-
-# 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
+# Filesystem permissions
+# PUID and PGID of the disk permissions
+PUID=1000
+PGID=1000
 
-# Flood username declared in  deluge RPC daemon
-FLOOD_PASSWORD=changeme # Flood Password for Deluge RPC daemon
-FLOOD_AUTOCREATE_USER_IN_DELUGE_DAEMON=false
+#################################################################################
+################# Various seedbox's autoconfiguration variables #################
+#################################################################################
 
-CALIBRE_PASSWORD=mycalibrepassword
+# 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"
 
-# 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
+FLOOD_AUTOCREATE_USER_IN_DELUGE_DAEMON=false

.gitignore

@@ -9,10 +9,17 @@ services.conf
 traefik/custom/dynamic*.yaml
 traefik/custom/custom-*.yaml
 samples/custom*/*.yaml
+samples/custom*/*.yaml.disabled
 
 config.yaml
 services/custom/*.yaml
 services/custom/*.yml
 services/generated/*.yaml
 
-authelia/*
+authelia/*
+.env.custom
+*.env
+env/*
+env
+
+docker-compose.yaml