From ee928a7fdc956603d94f3cc7ee1bde5dc4bf60f4 Mon Sep 17 00:00:00 2001
From: Ben Busby <benbusby@protonmail.com>
Date: Mon, 3 May 2021 14:23:44 -0400
Subject: [PATCH] Add env_file option to docker-compose, refactor whoogle.env

The env_file option is a better way of loading environment variables
from whoogle.env, and has been added to docker-compose.yml.

The whoogle.env file had comments after each example setting, and it was
not clear that these comments needed to be removed when setting new
values. The comments for each variable have been moved above the
appropriate variable to reduce confusion.

See #303 for initial discussion
---
 docker-compose.yml |  4 ++--
 whoogle.env        | 41 +++++++++++++++++++++++++++++------------
 2 files changed, 31 insertions(+), 14 deletions(-)

diff --git a/docker-compose.yml b/docker-compose.yml
index f2e8797..cbdb2ae 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -37,8 +37,8 @@ services:
       #- WHOOGLE_ALT_YT=invidious.snopyta.org
       #- WHOOGLE_ALT_IG=bibliogram.art/u
       #- WHOOGLE_ALT_RD=libredd.it
-      # Load environment variables from whoogle.env
-      #- WHOOGLE_DOTENV=1
+    #env_file: # Alternatively, load variables from whoogle.env
+      #- whoogle.env
     ports:
       - 5000:5000
     restart: unless-stopped
diff --git a/whoogle.env b/whoogle.env
index 6d6cdab..5435b3b 100644
--- a/whoogle.env
+++ b/whoogle.env
@@ -1,5 +1,8 @@
-# You can set Whoogle environment variables here, but must set
-# WHOOGLE_DOTENV=1 in your deployment to enable these values
+# You can set Whoogle environment variables here, but must
+# modify your deployment to enable these values:
+#  - Local: Set WHOOGLE_DOTENV=1
+#  - docker-compose: Uncomment the env_file option
+#  - docker: Add "--env-file ./whoogle.env" to your build command
 
 #WHOOGLE_ALT_TW=nitter.net
 #WHOOGLE_ALT_YT=invidious.snopyta.org
@@ -13,15 +16,29 @@
 #WHOOGLE_PROXY_LOC=""
 #HTTPS_ONLY=1
 
-#WHOOGLE_CONFIG_COUNTRY=countryUK  # See app/static/settings/countries.json for values
-#WHOOGLE_CONFIG_LANGUAGE=lang_en   # See app/static/settings/languages.json for values
-#WHOOGLE_CONFIG_SEARCH_LANGUAGE=lang_en   # See app/static/settings/languages.json for values
-#WHOOGLE_CONFIG_DARK=1  # Dark mode
-#WHOOGLE_CONFIG_SAFE=1  # Safe searches
-#WHOOGLE_CONFIG_ALTS=1  # Use social media site alternatives
-#WHOOGLE_CONFIG_TOR=1   # Use Tor if available
-#WHOOGLE_CONFIG_NEW_TAB=1  # Open results in new tab
-#WHOOGLE_CONFIG_VIEW_IMAGE=1  # Enable View Image option
-#WHOOGLE_CONFIG_GET_ONLY=1 # Search using GET requests only
+# See app/static/settings/countries.json for values
+#WHOOGLE_CONFIG_COUNTRY=countryUK
+# See app/static/settings/languages.json for values
+#WHOOGLE_CONFIG_LANGUAGE=lang_en
+# See app/static/settings/languages.json for values
+#WHOOGLE_CONFIG_SEARCH_LANGUAGE=lang_en
+# Disable changing of config from client
+#WHOOGLE_CONFIG_DISABLE=1
+# Dark mode
+#WHOOGLE_CONFIG_DARK=1
+# Safe search mode
+#WHOOGLE_CONFIG_SAFE=1
+# Use social media site alternatives (nitter, bibliogram, etc)
+#WHOOGLE_CONFIG_ALTS=1
+# Enable "View Image" option
+#WHOOGLE_CONFIG_VIEW_IMAGE=1
+# Use Tor if available
+#WHOOGLE_CONFIG_TOR=1
+# Open results in new tab
+#WHOOGLE_CONFIG_NEW_TAB=1
+# Search using GET requests only (exposes query in logs)
+#WHOOGLE_CONFIG_GET_ONLY=1
+# Set instance URL
 #WHOOGLE_CONFIG_URL=https://<whoogle url>/
+# Set custom CSS styling/theming
 #WHOOGLE_CONFIG_STYLE=":root { /* LIGHT THEME COLORS */ --whoogle-background: #d8dee9; --whoogle-accent: #2e3440; --whoogle-text: #3B4252; --whoogle-contrast-text: #eceff4; --whoogle-secondary-text: #70757a; --whoogle-result-bg: #fff; --whoogle-result-title: #4c566a; --whoogle-result-url: #81a1c1; --whoogle-result-visited: #a3be8c; /* DARK THEME COLORS */ --whoogle-dark-background: #222; --whoogle-dark-accent: #685e79; --whoogle-dark-text: #fff; --whoogle-dark-contrast-text: #000; --whoogle-dark-secondary-text: #bbb; --whoogle-dark-result-bg: #000; --whoogle-dark-result-title: #1967d2; --whoogle-dark-result-url: #4b11a8; --whoogle-dark-result-visited: #bbbbff; }"