Archives/whoogle-search
2
0
Fork 0
mirror of https://github.com/benbusby/whoogle-search synced 2024-11-14 18:12:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
cec10e81d3
whoogle-search/whoogle.template.env

93 lines
3.1 KiB
Bash
Raw Normal View History

Refactor whoogle.env -> whoogle.template.env Renamed to avoid collision issues for users who update the env file when running their instance. Non-template env file is gitignored to avoid accidental tracking. Fixes #467
2021-10-18 21:01:48 +00:00
# ----------------------------------
# Rename to "whoogle.env" before use
# ----------------------------------
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
2021-05-03 18:23:44 +00:00
# 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
Allow setting environment variables in whoogle.env (#237) This allows the user to enable their preferred settings in a variety of ways, depending on their deployment preference. Values added to whoogle.env can be enabled using WHOOGLE_DOTENV=1, in which case all values in the env var file will overwrite defaults or user provided settings. Co-authored-by: Ben Busby <benbusby@protonmail.com>
2021-03-28 17:27:08 +00:00
Use farside.link for frontend alternatives in results (#560) * Integrate Farside into Whoogle When instances are ratelimited (when a captcha is returned instead of the user's search results) the user can now hop to a new instance via Farside, a new backend service that redirects users to working instances of a particular frontend. In this case, it presents a user with a Farside link to a new Whoogle (or Searx) instance instead, so that the user can resume their search. For the generated Farside->Whoogle link, the generated link includes the user's current Whoogle configuration settings as URL params, to ensure a more seamless transition between instances. This doesn't translate to the Farside->Searx link, but potentially could with some changes. * Expand conversion of config<->url params Config settings can now be translated to and from URL params using a predetermined set of "safe" keys (i.e. config settings that easily translate to URL params). * Allow jumping instances via Farside when ratelimited When instances are ratelimited (when a captcha is returned instead of the user's search results) the user can now hop to a new instance via Farside, a new backend service that redirects users to working instances of a particular frontend. In this case, it presents a user with a Farside link to a new Whoogle (or Searx) instance instead, so that the user can resume their search. For the generated Farside->Whoogle link, the generated link includes the user's current Whoogle configuration settings as URL params, to ensure a more seamless transition between instances. This doesn't translate to the Farside->Searx link, but potentially could with some changes. Closes #554 Closes #559
2021-12-09 00:27:33 +00:00
#WHOOGLE_ALT_TW=farside.link/nitter
#WHOOGLE_ALT_YT=farside.link/invidious
#WHOOGLE_ALT_IG=farside.link/bibliogram/u
#WHOOGLE_ALT_RD=farside.link/libreddit
#WHOOGLE_ALT_MD=farside.link/scribe
Update remaining alternative frontends to use Farside Wikipedia, imgur, and translate alternatives were all still using hardcoded URLs when replaced with their respective alternative frontend. This updates them to use farside instead.
2022-03-21 16:08:52 +00:00
#WHOOGLE_ALT_TL=farside.link/lingva
#WHOOGLE_ALT_IMG=farside.link/rimgo
#WHOOGLE_ALT_WIKI=farside.link/wikiless
Support quora and imdb alts through Farside Farside can now redirect quora links to querte instances and imdb links to libremdb instances. This updates Whoogle to perform link replacements for both services when site alts are configured.
2022-08-01 17:49:09 +00:00
#WHOOGLE_ALT_IMDB=farside.link/libremdb
#WHOOGLE_ALT_QUORA=farside.link/quetre
Allow setting environment variables in whoogle.env (#237) This allows the user to enable their preferred settings in a variety of ways, depending on their deployment preference. Values added to whoogle.env can be enabled using WHOOGLE_DOTENV=1, in which case all values in the env var file will overwrite defaults or user provided settings. Co-authored-by: Ben Busby <benbusby@protonmail.com>
2021-03-28 17:27:08 +00:00
#WHOOGLE_USER=""
#WHOOGLE_PASS=""
#WHOOGLE_PROXY_USER=""
#WHOOGLE_PROXY_PASS=""
#WHOOGLE_PROXY_TYPE=""
#WHOOGLE_PROXY_LOC=""
Disable in-app CSP unless enabled via WHOOGLE_CSP The default CSP is only helpful for some, and can break instances for others. Since these aren't always necessary and are occasionally set by the user's preferred reverse proxy, it is being disabled unless explicitly enabled by setting `WHOOGLE_CSP`. Fixes #493
2021-11-29 22:49:35 +00:00
#WHOOGLE_CSP=1
Allow setting environment variables in whoogle.env (#237) This allows the user to enable their preferred settings in a variety of ways, depending on their deployment preference. Values added to whoogle.env can be enabled using WHOOGLE_DOTENV=1, in which case all values in the env var file will overwrite defaults or user provided settings. Co-authored-by: Ben Busby <benbusby@protonmail.com>
2021-03-28 17:27:08 +00:00
#HTTPS_ONLY=1
Allow defining initial config state w/ env vars This introduces a set of environment variables that can be used for defining initial config state, to expedite the process of destroying/relaunching instances quickly with the same settings every time. Closes #228 Closes #195
2021-03-28 18:24:57 +00:00
Add support for relative search results (#715) * Relativization of search results * Fix JavaScript error when opening images * Replace single-letter logo and remove sign-in link * Add `WHOOGLE_URL_PREFIX` env var to support relative path redirection The `WHOOGLE_URL_PREFIX` var can now be set to fix internal app redirects, such as the `/session` redirect performed on the first visit to the Whoogle home page. Co-authored-by: Ben Busby <contact@benbusby.com>
2022-04-18 21:27:45 +00:00
# The URL prefix to use for the whoogle instance (i.e. "/whoogle")
#WHOOGLE_URL_PREFIX=""
Document WHOOGLE_CONFIG_NEAR env var Fixes #406
2021-09-15 22:00:36 +00:00
# Restrict results to only those near a particular city
#WHOOGLE_CONFIG_NEAR=denver
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
2021-05-03 18:23:44 +00:00
# See app/static/settings/countries.json for values
Make country var value compatible with `gl` param
2021-12-01 03:18:40 +00:00
#WHOOGLE_CONFIG_COUNTRY=US
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# See app/static/settings/languages.json for values
#WHOOGLE_CONFIG_LANGUAGE=lang_en
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# See app/static/settings/languages.json for values
#WHOOGLE_CONFIG_SEARCH_LANGUAGE=lang_en
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Disable changing of config from client
#WHOOGLE_CONFIG_DISABLE=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
# Block websites from search results (comma-separated list)
#WHOOGLE_CONFIG_BLOCK=pinterest.com,whitehouse.gov
Allow theme to mirror user system settings Introduces a new config element and environment variable (WHOOGLE_CONFIG_THEME) for setting the theme of the app. Rather than just having either light or dark, this allows a user to have their instance use their current system light/dark preference to determine the theme to use. As a result, the dark mode setting (and WHOOGLE_CONFIG_DARK) have been deprecated, but will still work as expected until a system theme has been chosen.
2021-06-28 14:26:51 +00:00
# Theme (light, dark, or system)
#WHOOGLE_CONFIG_THEME=system
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Safe search mode
#WHOOGLE_CONFIG_SAFE=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Use social media site alternatives (nitter, bibliogram, etc)
#WHOOGLE_CONFIG_ALTS=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Use Tor if available
#WHOOGLE_CONFIG_TOR=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Open results in new tab
#WHOOGLE_CONFIG_NEW_TAB=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
Add "view image" functionality (#268) * add view image option * prevent whoogle links from opening in a new tab. * remove view image template on mobile requests * change loop values to be more robust to the number of images * Update app/templates/imageresults.html * fix "Basically the .cvifge class needs width: 100%; in order to expand the search input to fit the form width." * Update app/templates/imageresults.html * remove hardcoded string from template * Add view image config var to app.json * Add view image config var to whoogle.env Co-authored-by: jacr13 <ramos.joao@protonmail.com> Co-authored-by: Ben Busby <benbusby@protonmail.com>
2021-04-16 14:16:14 +00:00
# Enable View Image option
Use farside.link for frontend alternatives in results (#560) * Integrate Farside into Whoogle When instances are ratelimited (when a captcha is returned instead of the user's search results) the user can now hop to a new instance via Farside, a new backend service that redirects users to working instances of a particular frontend. In this case, it presents a user with a Farside link to a new Whoogle (or Searx) instance instead, so that the user can resume their search. For the generated Farside->Whoogle link, the generated link includes the user's current Whoogle configuration settings as URL params, to ensure a more seamless transition between instances. This doesn't translate to the Farside->Searx link, but potentially could with some changes. * Expand conversion of config<->url params Config settings can now be translated to and from URL params using a predetermined set of "safe" keys (i.e. config settings that easily translate to URL params). * Allow jumping instances via Farside when ratelimited When instances are ratelimited (when a captcha is returned instead of the user's search results) the user can now hop to a new instance via Farside, a new backend service that redirects users to working instances of a particular frontend. In this case, it presents a user with a Farside link to a new Whoogle (or Searx) instance instead, so that the user can resume their search. For the generated Farside->Whoogle link, the generated link includes the user's current Whoogle configuration settings as URL params, to ensure a more seamless transition between instances. This doesn't translate to the Farside->Searx link, but potentially could with some changes. Closes #554 Closes #559
2021-12-09 00:27:33 +00:00
#WHOOGLE_CONFIG_VIEW_IMAGE=1
Add "view image" functionality (#268) * add view image option * prevent whoogle links from opening in a new tab. * remove view image template on mobile requests * change loop values to be more robust to the number of images * Update app/templates/imageresults.html * fix "Basically the .cvifge class needs width: 100%; in order to expand the search input to fit the form width." * Update app/templates/imageresults.html * remove hardcoded string from template * Add view image config var to app.json * Add view image config var to whoogle.env Co-authored-by: jacr13 <ramos.joao@protonmail.com> Co-authored-by: Ben Busby <benbusby@protonmail.com>
2021-04-16 14:16:14 +00:00
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
2021-05-03 18:23:44 +00:00
# Search using GET requests only (exposes query in logs)
#WHOOGLE_CONFIG_GET_ONLY=1
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
Add missing env vars to readme [skip ci] (#584)
2021-12-19 18:42:52 +00:00
# Remove everything except basic result cards from all search queries
#WHOOGLE_MINIMAL=0
# Set the number of results per page
#WHOOGLE_RESULTS_PER_PAGE=10
# Controls visibility of autocomplete/search suggestions
#WHOOGLE_AUTOCOMPLETE=1
# The port where Whoogle will be exposed
#EXPOSE_PORT=5000
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
2021-05-03 18:23:44 +00:00
# Set instance URL
Allow defining initial config state w/ env vars This introduces a set of environment variables that can be used for defining initial config state, to expedite the process of destroying/relaunching instances quickly with the same settings every time. Closes #228 Closes #195
2021-03-28 18:24:57 +00:00
#WHOOGLE_CONFIG_URL=https://<whoogle url>/
Block websites from search results via user config (#304) * Block websites in search results via user config Adds a new config field "Block" to specify a comma separated list of websites to block in search results. This is applied for all searches. * Add test for blocking sites from search results * Document WHOOGLE_CONFIG_BLOCK usage * Strip '-site:' filters from query in header template The 'behind the scenes' site filter applied for blocked sites was appearing in the query field when navigating between search categories (all -> images -> news, etc). This prevents the filter from appearing in all except "images", since the image category uses a separate header. This should eventually be addressed when the image page can begin using the standard whoogle header, but until then, the filter will still appear for image searches.
2021-05-07 15:45:53 +00:00
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
2021-05-03 18:23:44 +00:00
# Set custom CSS styling/theming
Allow defining initial config state w/ env vars This introduces a set of environment variables that can be used for defining initial config state, to expedite the process of destroying/relaunching instances quickly with the same settings every time. Closes #228 Closes #195
2021-03-28 18:24:57 +00:00
#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; }"
Encode config params in URL (#842) Adds support for encoding (and optionally encrypting) user config values as a single string that can be passed to any endpoint with the "preferences" url param. Co-authored-by: Ben Busby <contact@benbusby.com>
2022-09-22 20:14:56 +00:00
# Enable preferences encryption (requires key)
#WHOOGLE_CONFIG_PREFERENCES_ENCRYPTED=1
# Set Key to encode config in url
#WHOOGLE_CONFIG_PREFERENCES_KEY="NEEDS_TO_BE_MODIFIED"
Reference in New Issue Copy Permalink