add: Better handling of environment values in docker-compose usage (#139

)

.env

@@ -0,0 +1,18 @@
+# docker compose and/or something doesn't like ':' in keys!
+# According to a comment on a SO question's comment
+# (https://stackoverflow.com/questions/47827887/bash-zsh-export-environment-variable-with-name-containing-a-colon)
+# this works in dotnet core! (not tested myself!)
+# PLEASE don't use these kind of special characters in keys!
+
+# providers:mastadon
+providers__mastodon__BaseAddress=https://example.com
+
+# providers:youtube
+providers__youtube__ApiKey=
+
+# providers:twitter
+providers__twitter__DefaultHeaders__Authorization=Bearer $TOKEN
+providers__twitter__ApiKey=
+providers__twitter__ApiSecretKey=
+providers__twitter__AccessToken=
+providers__twitter__AccessTokenSecret=

.env.local

@@ -0,0 +1,18 @@
+# docker compose and/or something doesn't like ':' in keys!
+# According to a comment on a SO question's comment
+# (https://stackoverflow.com/questions/47827887/bash-zsh-export-environment-variable-with-name-containing-a-colon)
+# this works in dotnet core! (not tested myself!)
+# PLEASE don't use these kind of special characters in keys!
+
+# providers:mastadon
+providers__mastodon__BaseAddress=https://example-local.com
+
+# providers:youtube
+providers__youtube__ApiKey=
+
+# providers:twitter
+providers__twitter__DefaultHeaders__Authorization=Bearer $TOKEN
+providers__twitter__ApiKey=
+providers__twitter__ApiSecretKey=
+providers__twitter__AccessToken=
+providers__twitter__AccessTokenSecret=

doc/README.md

@@ -85,7 +85,7 @@ TagzApp includes docker support and docker-compose files for easy deployment. Yo
 git clone https://github.com/FritzAndFriends/TagzApp
 cd TagzApp
 
-# update docker-compose.yml as needed (custom API tokens, etc.)
+# update primarily .env and docker-compose.yml as needed (custom API tokens, etc.)
 docker compose -f docker-compose.yml up
 
 ```
@@ -97,7 +97,7 @@ docker compose -f docker-compose.yml up
 git clone https://github.com/FritzAndFriends/TagzApp
 cd TagzApp
 
-# update docker-compose.local.yml as needed (custom API tokens, etc.)
+# update primarily .env.local and docker-compose.local.yml as needed (custom API tokens, etc.)
 docker compose -f docker-compose.local.yml up --build
 
 # or
@@ -116,11 +116,13 @@ You don't *need* to override any configurations, the app will work out of the bo
 
 In case you do have your own API keys or other values (see the  the [`appsettings.json`](../src/TagzApp.Web/appsettings.json) for what can be supplied), then you can supply them like this:
 
+* any [`appsettings.json`](../src/TagzApp.Web/appsettings.json) can be set in `.env` and `.env.local` files. Please set them this way: `key__subkey__property=value`. See the provided .env files for examples.
+
 * from `docker-compose.yml` - use `key:subkey:property=value` syntax. See the docker-compose files for examples. Ex.
 
 ```
 environment:
 	- providers:twitter:ApiKey=MySecretKey
 ```
 
-* from `docker run` - use `-e "providers:twitter:ApiKey=MySecretKey"`. You need to repeat the `-e ` flag for each override.
+* from `docker run` - use `-e "providers:twitter:ApiKey=MySecretKey"`. You need to repeat the `-e ` flag for each override. 

docker-compose.local.yml

@@ -1,4 +1,4 @@
-version: '3.7'
+version: "3.7"
 services:
   web:
     container_name: tagzapp.web
@@ -8,12 +8,7 @@ services:
       context: .
     ports:
       - "80" # runs on a random local port. Change to "8080:80" if you want to run on localhost:8080
-
-    # environment:
-    # - providers:mastodon:BaseAddress=https://example.com
-    # - providers:youtube:ApiKey=
-    # - providers:twitter:DefaultHeaders:Authorization=Bearer $TOKEN
-    # - providers:twitter:ApiKey=
-    # - providers:twitter:ApiSecretKey=
-    # - providers:twitter:AccessToken=
-    # - providers:twitter:AccessTokenSecret=
+    env_file:
+      # when .env values are used in this docker-compose file like 'hostname: $hostname' for example it is strongly recommended to inject them by referencing them like 'docker compose up --env-file .env' or 'docker compose up --env-file .env.local'
+      - .env
+      - .env.local

docker-compose.yml

@@ -1,15 +1,11 @@
-version: '3.7'
+version: "3.7"
 services:
   web:
     container_name: tagzapp.web
     hostname: tagzappweb
     image: ghcr.io/fritzandfriends/tagzapp:latest
     ports:
       - "80" # runs on a random local port. Change to "8080:80" if you want to run on localhost:8080
-    # environment:
-    # - providers:youtube:ApiKey=
-    # - providers:twitter:DefaultHeaders:Authorization=Bearer $TOKEN
-    # - providers:twitter:ApiKey=
-    # - providers:twitter:ApiSecretKey=
-    # - providers:twitter:AccessToken=
-    # - providers:twitter:AccessTokenSecret=
+    env_file:
+      # when .env values are used in this docker-compose file like 'hostname: $hostname' for example it is strongly recommended to inject them by referencing them like 'docker compose up --env-file .env' or 'docker compose up --env-file .env.local'
+      - .env