From 83b4e2ff20c592a0d51df080ae2b565395a88e67 Mon Sep 17 00:00:00 2001 From: Viren070 Date: Thu, 6 Mar 2025 21:43:02 +0000 Subject: [PATCH] docs: improve .env docs --- .env | 53 ++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 38 insertions(+), 15 deletions(-) diff --git a/.env b/.env index 2e4abf1..65099a7 100644 --- a/.env +++ b/.env @@ -14,10 +14,14 @@ # docker compose up -d # it will only start the default profile. # +# If you only want to use the default profile, you can leave the COMPOSE_PROFILES variable empty. +# This will only include some basic services used for monitoring and managing the other services and server management. +# This is useful if you aren't interested in any of the additional services I have included in this template. +# # If you want to make use of the additional profiles, you can do one of the following: # -# You should set the profiles that you want to use by setting the DOCKER_COMPOSE_PROFILES variable below using a space separated list. -# e.g. DOCKER_COMPOSE_PROFILES="stremio seanime" +# You should set the profiles that you want to use by setting the COMPOSE_PROFILES variable below using a space separated list. +# e.g. COMPOSE_PROFILES="stremio seanime" # # You can also use the --profile flag to specify which profile you want to use when running the compose file, but this will need to be specified # each time, even when you want to down the containers. @@ -26,7 +30,7 @@ # You can edit the compose.yaml to remove a service from a profile by just removing the profile from the profiles list for that service # e.g. profiles: ["stremio", "all"] -> profiles: ["all"] # Now, when you use the --profile flag with stremio, that service will not be started. -# If you remove the profiles list altogether, the service will always be started, regardless of the profile you use. +# If you remove the profiles list altogether, the service will always be started, regardless of the profile(s) you use. # # Find a list of the available profiles and the services they include at: https://guides.viren070.me/selfhosting/template # You can also look at the compose.yaml file to see which services are included in each profile. @@ -52,6 +56,7 @@ COMPOSE_PROFILES= # Also make sure that both port 80 and 443 are open on your server. # --------------------------------------------------------- # This is the email that will be used to register with Let's Encrypt for SSL certificates. +# This is what allows you to access the services over HTTPS, which is required for Stremio Addons. LETSENCRYPT_EMAIL= # --------------------------------------------------------- @@ -73,6 +78,7 @@ LETSENCRYPT_EMAIL= # sudo apt-get install apache2-utils # # Then, rerun the htpasswd command above. +# You would use the password before hashing when logging in to Dozzle. # # Note that this command will output the hash with any $ characters already escaped, so you can copy and paste it directly into the .env file. # --------------------------------------------------------- @@ -88,13 +94,13 @@ DOZZLE_HOSTNAME= # --------------------------------------------------------- # The AUTO_UPDATE_SCHEDULE is a cron expression that is used to schedule the auto update of the containers. # It is different from a normal cron expression, as it has an additional field at the beginning for seconds. -# See @url:https://pkg.go.dev/github.com/robfig/cron@v1.2.0#hdr-CRON_Expression_Format +# See https://pkg.go.dev/github.com/robfig/cron@v1.2.0#hdr-CRON_Expression_Format # # The AUTO_UPDATE_NOTIFICATION_URL is the URL that will be used to send notifications about the auto update. -# You can find more information about the available services at @url:https://containrrr.dev/shoutrrr/v0.8/services/overview/ +# You can find more information about the available services at https://containrrr.dev/shoutrrr/v0.8/services/overview/ # Make sure the format of the AUTO_UPDATE_NOTIFICATION_URL is correct. -# e.g. For discordd, the format is discord://token@id +# e.g. For discord, the format is discord://token@id # Discord webhook URLs are in the format https://discord.com/api/webhooks// # So the URL would be discord://@ # --------------------------------------------------------- @@ -128,19 +134,26 @@ STATUS_PAGE_HOSTNAME= # Honey: https://github.com/dani3l0/honey (showcase: https://honeyy.vercel.app/) # Flame: https://github.com/pawelmalak/flame # -# Flame will come preconfigured with all the services that are available in the compose.yaml file. +# Flame will come preconfigured with all the services that are available in the compose.yaml file. +# (Settings (bottom left icon) > App > Log in > Docker > Set 'Use Docker API' to True) # Honey looks far better and is more compact, but you will need to manually add the services to it. # # Luckily, I have provided my configuration for Honey, so you can use that. -# If you followed the instructions in the README, you should have a file called config.json in the ./data/honey directory. -# You will simply need to adjust the URLs to match your domain names and remove any services you don't have. -# You can also reorder the services list as you like. +# If you followed the instructions correctly and ran the install.sh, you should have a file called config.json in the ./data/honey directory. +# You will simply need to adjust the URLs to match your domain names. +# +# To make this slightly easier, you can run the following command to replace the domain names with your domain names, any subdomains will need to be checked +# to see if they are correct. Just replace mydomain.com with your domain name. +# sed -i "s/yourdomain.com/mydomain.com/g" ./data/honey/config.json +# +# You can also reorder the services list as you like, and remove any services that you don't use or don't want to show up on the start page. # # You can access the start page at https://${FLAME_HOSTNAME} or https://${HONEY_HOSTNAME} # # I've personally set HONEY_HOSTNAME to my main domain name, so that I can access the start page at the root of my domain. # e.g. if my domain was example.com, I would access the start page at https://example.com -# This does require a separate DNS record, so make sure you set that up. +# This does require a separate DNS record, so make sure you set that up. It would just be another A record +# pointing to your server's IP address but using the root (e.g. example.com) as the name, on Cloudflare, this can be denoted by @. # --------------------------------------------------------- FLAME_HOSTNAME= FLAME_PASSWORD= @@ -173,6 +186,10 @@ DASHDOT_CUSTOM_HOST= # - plausible # - seanime # - searxng +# - zipline +# - vaultwarden +# - minecraft +# - nzbhydra2 # - debrid_media_server # - all # @@ -195,7 +212,7 @@ DASHDOT_CUSTOM_HOST= # --------------------------------------------------------- # # Get your API key and Access token from https://www.themoviedb.org/settings/api -# Needed by: AIOStreams, MediaFusion, TMDB Addon +# Needed by: AIOStreams (for default stremio jackett tmdb api key only), MediaFusion, TMDB Addon TMDB_API_KEY= # Needed by: Jackettio TMDB_ACCESS_TOKEN= @@ -489,7 +506,7 @@ NZBHYDRA2_HOSTNAME= # --------------------------------------------------------- # Profiles: seanime, all # -# The SEANIME_HASHED_PASSWORD is the hashed password that you will use to access the Seanime service. +# The SEANIME_HASHED_PASSWORD is the hash of the password that you will use to access the Seanime service. # To get the hash for SEANIME_HASHED_PASSWORD, run the following command in your terminal, replacing with your desired password. # # htpasswd -niBb user | cut -d ":" -f 2 | sed 's/\$/\$\$/g' @@ -498,11 +515,16 @@ NZBHYDRA2_HOSTNAME= # sudo apt-get install apache2-utils # # Then, rerun the htpasswd command above. +# You would use the password before hashing when logging in to Seanime. # # IMPORTANT: Once you have the container running, you need to edit Seanime's config.toml file in order to set the correct host. # Run the following command to do this. # sudo sed -i 's/127.0.0.1/0.0.0.0/' ./data/seanime/config.toml -# Then, restart the container by running `sudo docker compose restart seanime +# Then, restart the container by running `sudo docker restart seanime +# +# Note: If you are planning on using this for local media, you will not be able to use an external player +# as we have set up a password for seanime. Unless you can find a way to pass basic http auth credentials to the player +# so that it can access the streaming URL from Seanime. # --------------------------------------------------------- SEANIME_HOSTNAME= SEANIME_USERNAME= @@ -619,7 +641,8 @@ VAULTWARDEN_HOSTNAME= # If you want to be able to access the minecraft server at a subdomain e.g. mc.example.com, you will need to set up a DNS record for that subdomain. # # You must first have an A record for the subdomain pointing to your server's IP address. -# If you have a wildcard DNS record, you do not need to do this. +# If you have a wildcard DNS record, you do not need to do this. Though, it does mean +# that all subdomains will point to your server. # --------------------------------------------------------- MINECRAFT_SERVER_ICON= MINECRAFT_SERVER_OVERRIDE_ICON=false