Archives/whoogle-search
2
0
Fork 0
mirror of https://github.com/benbusby/whoogle-search synced 2024-10-30 09:20:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
843632a22c
whoogle-search/Dockerfile

81 lines
1.7 KiB
Docker
Raw Normal View History

Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
FROM python:3.8-slim as builder
Added basic docker setup
2020-04-08 20:05:28 +00:00
Add tor and http/socks proxy support (#137) * Add tor and http/socks proxy support Allows users to enable/disable tor from the config menu, which will forward all requests through Tor. Also adds support for setting environment variables for alternative proxy support. Setting the following variables will forward requests through the proxy: - WHOOGLE_PROXY_USER (optional) - WHOOGLE_PROXY_PASS (optional) - WHOOGLE_PROXY_TYPE (required) - Can be "http", "socks4", or "socks5" - WHOOGLE_PROXY_LOC (required) - Format: "<ip address>:<port>" See #30 * Refactor acquire_tor_conn -> acquire_tor_identity Also updated travis CI to set up tor * Add check for Tor socket on init, improve Tor error handling Initializing the app sends a heartbeat request to Tor to check for availability, and updates the home page config options accordingly. This heartbeat is sent on every request, to ensure Tor support can be reconfigured without restarting the entire app. If Tor support is enabled, and a subsequent request fails, then a new TorError exception is raised, and the Tor feature is disabled until a valid connection is restored. The max attempts has been updated to 10, since 5 seemed a bit too low for how quickly the attempts go by. * Change send_tor_signal arg type, update function doc send_tor_signal now accepts a stem.Signal arg (a bit cleaner tbh). Also added the doc string for the "disable" attribute in TorError. * Fix tor identity logic in Request.send * Update proxy init, change proxyloc var name Proxy is now only initialized if both type and location are specified, as neither have a default fallback and both are required. I suppose the type could fall back to http, but seems safer this way. Also refactored proxyurl -> proxyloc for the runtime args in order to match the Dockerfile args. * Add tor/proxy support for Docker builds, fix opensearch/init The Dockerfile is now updated to include support for Tor configuration, with a working torrc file included in the repo. An issue with opensearch was fixed as well, which was uncovered during testing and was simple enough to fix here. Likewise, DDG bang gen was updated to only ever happen if the file didn't exist previously, as testing with the file being regenerated every time was tedious. * Add missing "@" for socks proxy requests
2020-10-29 00:47:42 +00:00
RUN apt-get update && apt-get install -y \
build-essential \
Add docker buildx gh action This automatically builds and pushes a cross platform image to Docker Hub.
2021-01-05 22:53:58 +00:00
libxml2-dev \
libxslt-dev \
Move ssl install to Dockerfile build stage
2021-02-26 17:04:06 +00:00
libssl-dev \
Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
libffi-dev
Add tor and http/socks proxy support (#137) * Add tor and http/socks proxy support Allows users to enable/disable tor from the config menu, which will forward all requests through Tor. Also adds support for setting environment variables for alternative proxy support. Setting the following variables will forward requests through the proxy: - WHOOGLE_PROXY_USER (optional) - WHOOGLE_PROXY_PASS (optional) - WHOOGLE_PROXY_TYPE (required) - Can be "http", "socks4", or "socks5" - WHOOGLE_PROXY_LOC (required) - Format: "<ip address>:<port>" See #30 * Refactor acquire_tor_conn -> acquire_tor_identity Also updated travis CI to set up tor * Add check for Tor socket on init, improve Tor error handling Initializing the app sends a heartbeat request to Tor to check for availability, and updates the home page config options accordingly. This heartbeat is sent on every request, to ensure Tor support can be reconfigured without restarting the entire app. If Tor support is enabled, and a subsequent request fails, then a new TorError exception is raised, and the Tor feature is disabled until a valid connection is restored. The max attempts has been updated to 10, since 5 seemed a bit too low for how quickly the attempts go by. * Change send_tor_signal arg type, update function doc send_tor_signal now accepts a stem.Signal arg (a bit cleaner tbh). Also added the doc string for the "disable" attribute in TorError. * Fix tor identity logic in Request.send * Update proxy init, change proxyloc var name Proxy is now only initialized if both type and location are specified, as neither have a default fallback and both are required. I suppose the type could fall back to http, but seems safer this way. Also refactored proxyurl -> proxyloc for the runtime args in order to match the Dockerfile args. * Add tor/proxy support for Docker builds, fix opensearch/init The Dockerfile is now updated to include support for Tor configuration, with a working torrc file included in the repo. An issue with opensearch was fixed as well, which was uncovered during testing and was simple enough to fix here. Likewise, DDG bang gen was updated to only ever happen if the file didn't exist previously, as testing with the file being regenerated every time was tedious. * Add missing "@" for socks proxy requests
2020-10-29 00:47:42 +00:00
Improved Dockerfile
2020-05-10 12:00:22 +00:00
COPY requirements.txt .
Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
RUN pip install --prefix /install --no-warn-script-location --no-cache-dir -r requirements.txt
FROM python:3.8-slim
RUN apt-get update && apt-get install -y \
libcurl4-openssl-dev \
tor \
Use curl-based healthcheck w/ new non-auth route The wget method seemed to have a possible issue with creating endless index.html copies (despite being specified to output to console only), so this has been updated to use curl instead. Also uses new non-authenticated "healthz" route to perform the healthcheck. Fix #316 Fix #313
2021-05-18 15:48:15 +00:00
curl \
Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
&& rm -rf /var/lib/apt/lists/*
Improved Dockerfile
2020-05-10 12:00:22 +00:00
Added volume mounted config to Dockerfile (#39)
2020-05-14 00:27:04 +00:00
ARG config_dir=/config
Update Dockerfile Fixed mkdir call to not error if config dir already exists
2020-05-16 15:11:00 +00:00
RUN mkdir -p $config_dir
Added volume mounted config to Dockerfile (#39)
2020-05-14 00:27:04 +00:00
VOLUME $config_dir
ENV CONFIG_VOLUME=$config_dir
Added basic authentication (#51) Username/password can be set either as Dockerfile build arguments or passed into the run script as "--userpass <username:password>"
2020-05-18 16:30:32 +00:00
ARG username=''
ENV WHOOGLE_USER=$username
ARG password=''
ENV WHOOGLE_PASS=$password
Add tor and http/socks proxy support (#137) * Add tor and http/socks proxy support Allows users to enable/disable tor from the config menu, which will forward all requests through Tor. Also adds support for setting environment variables for alternative proxy support. Setting the following variables will forward requests through the proxy: - WHOOGLE_PROXY_USER (optional) - WHOOGLE_PROXY_PASS (optional) - WHOOGLE_PROXY_TYPE (required) - Can be "http", "socks4", or "socks5" - WHOOGLE_PROXY_LOC (required) - Format: "<ip address>:<port>" See #30 * Refactor acquire_tor_conn -> acquire_tor_identity Also updated travis CI to set up tor * Add check for Tor socket on init, improve Tor error handling Initializing the app sends a heartbeat request to Tor to check for availability, and updates the home page config options accordingly. This heartbeat is sent on every request, to ensure Tor support can be reconfigured without restarting the entire app. If Tor support is enabled, and a subsequent request fails, then a new TorError exception is raised, and the Tor feature is disabled until a valid connection is restored. The max attempts has been updated to 10, since 5 seemed a bit too low for how quickly the attempts go by. * Change send_tor_signal arg type, update function doc send_tor_signal now accepts a stem.Signal arg (a bit cleaner tbh). Also added the doc string for the "disable" attribute in TorError. * Fix tor identity logic in Request.send * Update proxy init, change proxyloc var name Proxy is now only initialized if both type and location are specified, as neither have a default fallback and both are required. I suppose the type could fall back to http, but seems safer this way. Also refactored proxyurl -> proxyloc for the runtime args in order to match the Dockerfile args. * Add tor/proxy support for Docker builds, fix opensearch/init The Dockerfile is now updated to include support for Tor configuration, with a working torrc file included in the repo. An issue with opensearch was fixed as well, which was uncovered during testing and was simple enough to fix here. Likewise, DDG bang gen was updated to only ever happen if the file didn't exist previously, as testing with the file being regenerated every time was tedious. * Add missing "@" for socks proxy requests
2020-10-29 00:47:42 +00:00
ARG proxyuser=''
ENV WHOOGLE_PROXY_USER=$proxyuser
ARG proxypass=''
ENV WHOOGLE_PROXY_PASS=$proxypass
ARG proxytype=''
ENV WHOOGLE_PROXY_TYPE=$proxytype
ARG proxyloc=''
ENV WHOOGLE_PROXY_LOC=$proxyloc
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
ARG whoogle_dotenv=''
ENV WHOOGLE_DOTENV=$whoogle_dotenv
Feature: https only -- adds option to enforce https on running instances (#48) * Adding HTTPS enforcement Command line runs of Whoogle Search through pip/pipx/etc will need the `--https-only` flag appended to the run command. Docker runs require the `use_https` build arg applied. * Update README.md Moved https-only note to top of docker run command, updated pip runner help output * Dockerfile: removed HTTPS enforcement, updated PORT setting Dockerfile no longer enforces an HTTPS connection, but still allows for setting via a build arg. The Flask server port is now configurable as a build arg as well, by setting a port number to "whoogle_port" * Fixed incorrect port assignment
2020-05-15 21:44:50 +00:00
ARG use_https=''
ENV HTTPS_ONLY=$use_https
ARG whoogle_port=5000
ENV EXPOSE_PORT=$whoogle_port
Fix default site alts in Dockerfile The Dockerfile was incorrectly assigning an empty string to the site alt values, which caused the filter to update relevant sites with an empty host. This replaces the empty string with the correct domain for each site alternative.
2021-01-11 19:00:15 +00:00
ARG twitter_alt='nitter.net'
Allow setting site alts using environment vars (#155) * Add ability to configure site alts w/ env vars Site alternatives (i.e. twitter.com -> nitter.net) can now be configured using environment variables: WHOOGLE_ALT_TW='nitter.net' # twitter alt WHOOGLE_ALT_YT='invidio.us' # youtube alt WHOOGLE_ALT_IG='bibliogram.art/u' # instagram alt Updated testing to confirm results have been modified. * Add site alt vars to docker settings and readme
2020-12-05 22:01:21 +00:00
ENV WHOOGLE_ALT_TW=$twitter_alt
Fix default site alts in Dockerfile The Dockerfile was incorrectly assigning an empty string to the site alt values, which caused the filter to update relevant sites with an empty host. This replaces the empty string with the correct domain for each site alternative.
2021-01-11 19:00:15 +00:00
ARG youtube_alt='invidious.snopyta.org'
Allow setting site alts using environment vars (#155) * Add ability to configure site alts w/ env vars Site alternatives (i.e. twitter.com -> nitter.net) can now be configured using environment variables: WHOOGLE_ALT_TW='nitter.net' # twitter alt WHOOGLE_ALT_YT='invidio.us' # youtube alt WHOOGLE_ALT_IG='bibliogram.art/u' # instagram alt Updated testing to confirm results have been modified. * Add site alt vars to docker settings and readme
2020-12-05 22:01:21 +00:00
ENV WHOOGLE_ALT_YT=$youtube_alt
Fix default site alts in Dockerfile The Dockerfile was incorrectly assigning an empty string to the site alt values, which caused the filter to update relevant sites with an empty host. This replaces the empty string with the correct domain for each site alternative.
2021-01-11 19:00:15 +00:00
ARG instagram_alt='bibliogram.art/u'
Fixing typo in Dockerfile (#235)
2021-03-22 14:16:24 +00:00
ENV WHOOGLE_ALT_IG=$instagram_alt
Add ability to redirect reddit.com to libredd.it (#180) * Adds the ability to redirect reddit.com to libredd.it using the existing "site alts" config setting. This adds the WHOOGLE_ALT_RD environment variable for optionally redirecting reddit links to libreddit (https://github.com/spikecodes/libreddit). * Include libreddit in home page site alt note
2021-01-23 22:43:53 +00:00
ARG reddit_alt='libredd.it'
ENV WHOOGLE_ALT_RD=$reddit_alt
Add lingva translation support in search (#360) * Add support for Lingva translations in results Searches that contain the word "translate" and are normal search queries (i.e. not news/images/video/etc) now create an iframe to a Lingva url to translate the user's search using their configured search language. The Lingva url can be configured using the WHOOGLE_ALT_TL env var, or will fall back to the official Lingva instance url (lingva.ml). For more info, visit https://github.com/TheDavidDelta/lingva-translate * Add basic test for lingva results * Allow user specified lingva instances through csp frame-src * Fix pep8 issue
2021-06-15 14:14:42 +00:00
ARG translate_alt='lingva.ml'
ENV WHOOGLE_ALT_TL=$translate_alt
Implement scribe.rip replacement for medium.com results (#463) scribe.rip is a privacy respecting front end for medium.com. This feature allows medium.com results to be replaced with scribe.rip links, and works for both regular medium.com domains as well as user specific subdomains (i.e. user.medium.com). [scribe.rip website](https://scribe.rip) [scribe.rip source code](https://git.sr.ht/~edwardloveall/scribe) Co-authored-by: Ben Busby <noreply+git@benbusby.com>
2021-10-16 18:22:00 +00:00
ARG medium_alt='scribe.rip'
ENV WHOOGLE_ALT_MD=$medium_alt
Allow setting site alts using environment vars (#155) * Add ability to configure site alts w/ env vars Site alternatives (i.e. twitter.com -> nitter.net) can now be configured using environment variables: WHOOGLE_ALT_TW='nitter.net' # twitter alt WHOOGLE_ALT_YT='invidio.us' # youtube alt WHOOGLE_ALT_IG='bibliogram.art/u' # instagram alt Updated testing to confirm results have been modified. * Add site alt vars to docker settings and readme
2020-12-05 22:01:21 +00:00
Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
WORKDIR /whoogle
COPY --from=builder /install /usr/local
Add heroku-regen script, rename config/ -> misc/ Introduces a new script for quickly regenerating a Heroku instance (typically with a new IP) to handle the rare circumstances where an instance is flagged by Google and prompted for a captcha. The config/ dir was renamed to misc/ to avoid confusion with the Docker mounted config volume, and to more closely match its intended purpose (which is to contain all miscellaneous features/scripts/etc that add functionality to Whoogle, but are not critical for general use).
2021-03-17 16:27:08 +00:00
COPY misc/tor/torrc /etc/tor/torrc
COPY misc/tor/start-tor.sh misc/tor/start-tor.sh
Use multi-stage container build (#210) This only adds necessary packages and files from the repo to reduce the image size. Co-authored-by: pred2k <does@not.exists>
2021-02-26 15:49:40 +00:00
COPY app/ app/
COPY run .
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
COPY whoogle.env .
Added basic docker setup
2020-04-08 20:05:28 +00:00
Set user ownership of static build dir
2021-07-02 20:13:42 +00:00
# Allow writing symlinks to build dir
RUN chown 102:102 app/static/build
Feature: https only -- adds option to enforce https on running instances (#48) * Adding HTTPS enforcement Command line runs of Whoogle Search through pip/pipx/etc will need the `--https-only` flag appended to the run command. Docker runs require the `use_https` build arg applied. * Update README.md Moved https-only note to top of docker run command, updated pip runner help output * Dockerfile: removed HTTPS enforcement, updated PORT setting Dockerfile no longer enforces an HTTPS connection, but still allows for setting via a build arg. The Flask server port is now configurable as a build arg as well, by setting a port number to "whoogle_port" * Fixed incorrect port assignment
2020-05-15 21:44:50 +00:00
EXPOSE $EXPOSE_PORT
Improved Dockerfile
2020-05-10 12:00:22 +00:00
Reduce docker healthcheck interval from 5m to 30s See #270
2021-04-07 16:39:12 +00:00
HEALTHCHECK --interval=30s --timeout=5s \
Use curl-based healthcheck w/ new non-auth route The wget method seemed to have a possible issue with creating endless index.html copies (despite being specified to output to console only), so this has been updated to use curl instead. Also uses new non-authenticated "healthz" route to perform the healthcheck. Fix #316 Fix #313
2021-05-18 15:48:15 +00:00
CMD curl -f http://localhost:${EXPOSE_PORT}/healthz || exit 1
Add healthcheck to Dockerfile See #184
2021-03-08 17:38:40 +00:00
Add heroku-regen script, rename config/ -> misc/ Introduces a new script for quickly regenerating a Heroku instance (typically with a new IP) to handle the rare circumstances where an instance is flagged by Google and prompted for a captcha. The config/ dir was renamed to misc/ to avoid confusion with the Docker mounted config volume, and to more closely match its intended purpose (which is to contain all miscellaneous features/scripts/etc that add functionality to Whoogle, but are not critical for general use).
2021-03-17 16:27:08 +00:00
CMD misc/tor/start-tor.sh & ./run
Reference in New Issue Copy Permalink