From b0bef5aa53d19d76baae5140c3b4ef87fed7f996 Mon Sep 17 00:00:00 2001 From: Bruvv Date: Sat, 1 Jan 2022 12:35:09 +0100 Subject: [PATCH] added more explaining --- whoogle/CHANGELOG.md | 1 + whoogle/DOCS.md | 100 +++++++++++++++++++++++++++++++++++++++++++ whoogle/config.json | 4 +- 3 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 whoogle/DOCS.md diff --git a/whoogle/CHANGELOG.md b/whoogle/CHANGELOG.md index a9e742528..835e9ba91 100644 --- a/whoogle/CHANGELOG.md +++ b/whoogle/CHANGELOG.md @@ -1,5 +1,6 @@ ## 0.7.1 - Changed the config handeling +- Added a docs with the config explaination. ## 0.7.0 - Initial release (latest builds) diff --git a/whoogle/DOCS.md b/whoogle/DOCS.md new file mode 100644 index 000000000..534a13b43 --- /dev/null +++ b/whoogle/DOCS.md @@ -0,0 +1,100 @@ + +## Environment Variables +There are a few optional environment variables available for customizing a Whoogle instance. These can be set manually, or copied into `whoogle.env` and enabled for your preferred deployment method: + +- Local runs: Set `WHOOGLE_DOTENV=1` before running +- With `docker-compose`: Uncomment the `env_file` option +- With `docker build/run`: Add `--env-file ./whoogle.env` to your command + +| Variable | Description | +| -------------------- | ----------------------------------------------------------------------------------------- | +| WHOOGLE_DOTENV | Load environment variables in `whoogle.env` | +| 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)) | +| WHOOGLE_ALT_TW | The twitter.com alternative to use when site alternatives are enabled in the config. | +| WHOOGLE_ALT_YT | The youtube.com alternative to use when site alternatives are enabled in the config. | +| WHOOGLE_ALT_IG | The instagram.com alternative to use when site alternatives are enabled in the config. | +| WHOOGLE_ALT_RD | The reddit.com alternative to use when site alternatives are enabled in the config. | +| WHOOGLE_ALT_TL | The Google Translate alternative to use. This is used for all "translate ____" searches. | +| WHOOGLE_ALT_MD | The medium.com alternative to use when site alternatives are enabled in the config. | +| WHOOGLE_AUTOCOMPLETE | Controls visibility of autocomplete/search suggestions. Default on -- use '0' to disable | +| WHOOGLE_MINIMAL | Remove everything except basic result cards from all search queries. | +| WHOOGLE_CSP | Sets a default set of 'Content-Security-Policy' headers | +| WHOOGLE_RESULTS_PER_PAGE | Set the number of results per page | + +### Config Environment Variables +These environment variables allow setting default config values, but can be overwritten manually by using the home page config menu. These allow a shortcut for destroying/rebuilding an instance to the same config state every time. + +| Variable | Description | +| ------------------------------ | --------------------------------------------------------------- | +| WHOOGLE_CONFIG_DISABLE | Hide config from UI and disallow changes to config by client | +| WHOOGLE_CONFIG_COUNTRY | Filter results by hosting country | +| WHOOGLE_CONFIG_LANGUAGE | Set interface language | +| WHOOGLE_CONFIG_SEARCH_LANGUAGE | Set search result language | +| WHOOGLE_CONFIG_BLOCK | Block websites from search results (use comma-separated list) | +| WHOOGLE_CONFIG_THEME | Set theme mode (light, dark, or system) | +| WHOOGLE_CONFIG_SAFE | Enable safe searches | +| WHOOGLE_CONFIG_ALTS | Use social media site alternatives (nitter, invidious, etc) | +| WHOOGLE_CONFIG_NEAR | Restrict results to only those near a particular city | +| WHOOGLE_CONFIG_TOR | Use Tor routing (if available) | +| WHOOGLE_CONFIG_NEW_TAB | Always open results in new tab | +| WHOOGLE_CONFIG_VIEW_IMAGE | Enable View Image option | +| WHOOGLE_CONFIG_GET_ONLY | Search using GET requests only | +| WHOOGLE_CONFIG_URL | The root url of the instance (`https:///`) | +| WHOOGLE_CONFIG_STYLE | The custom CSS to use for styling (should be single line) | + +## Usage +Same as most search engines, with the exception of filtering by time range. + +To filter by a range of time, append ":past