From a97e837b098882508d3a8a0454539f6739e37f00 Mon Sep 17 00:00:00 2001 From: Ben Busby Date: Tue, 3 Nov 2020 17:28:43 -0500 Subject: [PATCH] Default to disabled environment vars, update readme Environment variables should by default be disabled, since they are optional and need further configuration by the user before enabling. Readme was updated to reflect this approach, as well as moving the documentation for the variables a bit lower and properly linking to them in other areas of the readme. --- README.md | 57 +++++++++++++++++++++++----------------------- docker-compose.yml | 18 +++++++-------- 2 files changed, 38 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 4b76586..9f57d64 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,11 @@ Contents 1. [Features](#features) 2. [Dependencies](#dependencies) 3. [Install/Deploy](#install) -4. [Usage](#usage) -5. [Extra Steps](#extra-steps) -6. [FAQ](#faq) -7. [Screenshots](#screenshots) +4. [Environment Variables](#environment-variables) +5. [Usage](#usage) +6. [Extra Steps](#extra-steps) +7. [FAQ](#faq) +8. [Screenshots](#screenshots) ## Features - No ads or sponsored content @@ -49,20 +50,6 @@ If using Heroku Quick Deploy, **you can skip this section**. - Ubuntu: `sudo apt-get install -y libcurl4-openssl-dev libssl-dev` - Arch: `pacman -S curl openssl` -## Environment Variables -There are a few optional environment variables available for customizing a Whoogle instance: - -| Variable | Description | -| ------------------ | -------------------------------------------------------------- | -| WHOOGLE_USER | The username for basic auth. WHOOGLE_PASS must also be set if used. | -| WHOOGLE_PASS | The password for basic auth. WHOOGLE_USER must also be set if used. | -| WHOOGLE_PROXY_USER | The username of the proxy server. | -| WHOOGLE_PROXY_PASS | The password of the proxy server. | -| WHOOGLE_PROXY_TYPE | The type of the proxy server. Can be "socks5", "socks4", or "http". | -| WHOOGLE_PROXY_LOC | The location of the proxy server (host or ip). | -| EXPOSE_PORT | The port where Whoogle will be exposed. | -| HTTPS_ONLY | Enforce HTTPS. (See [here](https://github.com/benbusby/whoogle-search#https-enforcement)) | - ## Install There are a few different ways to begin using the app, depending on your preferences: @@ -111,7 +98,7 @@ optional arguments: --debug Activates debug mode for the server (default False) --https-only Enforces HTTPS redirects for all requests (default False) ``` -You may want to set the environment variables in the host OS. +See the [available environment variables](#environment-variables) for additional configuration. ### E) Manual Clone the repo and run the following commands to start the app in a local-only environment: @@ -124,7 +111,7 @@ source venv/bin/activate pip install -r requirements.txt ./run ``` -You may want to set the environment variables in the host OS. +See the [available environment variables](#environment-variables) for additional configuration. #### systemd Configuration After building the virtual environment, you can add the following to `/lib/systemd/system/whoogle.service` to set up a Whoogle Search systemd service: @@ -134,14 +121,14 @@ After building the virtual environment, you can add the following to `/lib/syste Description=Whoogle [Service] -# Basic auth configuration, remove to disable -Environment=WHOOGLE_USER=username -Environment=WHOOGLE_PASS=password -# Proxy configuration, remove to disable -Environment=WHOOGLE_PROXY_USER=username -Environment=WHOOGLE_PROXY_PASS=password -Environment=WHOOGLE_PROXY_TYPE=socks5 -Environment=WHOOGLE_PROXY_LOC=ip +# Basic auth configuration, uncomment to enable +#Environment=WHOOGLE_USER= +#Environment=WHOOGLE_PASS= +# Proxy configuration, uncomment to enable +#Environment=WHOOGLE_PROXY_USER= +#Environment=WHOOGLE_PROXY_PASS= +#Environment=WHOOGLE_PROXY_TYPE= Type=simple User=root WorkingDirectory= @@ -230,6 +217,20 @@ Depending on your preferences, you can also deploy the app yourself on your own - SSL certificates (free through [Let's Encrypt](https://letsencrypt.org/getting-started/)) - A bit more experience or willingness to work through issues +## Environment Variables +There are a few optional environment variables available for customizing a Whoogle instance: + +| Variable | Description | +| ------------------ | -------------------------------------------------------------- | +| WHOOGLE_USER | The username for basic auth. WHOOGLE_PASS must also be set if used. | +| WHOOGLE_PASS | The password for basic auth. WHOOGLE_USER must also be set if used. | +| WHOOGLE_PROXY_USER | The username of the proxy server. | +| WHOOGLE_PROXY_PASS | The password of the proxy server. | +| WHOOGLE_PROXY_TYPE | The type of the proxy server. Can be "socks5", "socks4", or "http". | +| WHOOGLE_PROXY_LOC | The location of the proxy server (host or ip). | +| EXPOSE_PORT | The port where Whoogle will be exposed. | +| HTTPS_ONLY | Enforce HTTPS. (See [here](https://github.com/benbusby/whoogle-search#https-enforcement)) | + ## Usage Same as most search engines, with the exception of filtering by time range. diff --git a/docker-compose.yml b/docker-compose.yml index 94a07fd..0d58aac 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,15 +4,15 @@ services: whoogle-search: image: benbusby/whoogle-search container_name: whoogle-search - environment: - # Basic auth configuration, remove to disable - - WHOOGLE_USER=username - - WHOOGLE_PASS=password - # Proxy configuration, remove to disable - - WHOOGLE_PROXY_USER=username - - WHOOGLE_PROXY_PASS=password - - WHOOGLE_PROXY_TYPE=socks5 - - WHOOGLE_PROXY_LOC=ip + #environment: # Uncomment to configure environment variables + # Basic auth configuration, uncomment to enable + #- WHOOGLE_USER= + #- WHOOGLE_PASS= + # Proxy configuration, uncomment to enable + #- WHOOGLE_PROXY_USER= + #- WHOOGLE_PROXY_PASS= + #- WHOOGLE_PROXY_TYPE= ports: - 5000:5000 restart: unless-stopped