nakidai
/
whoogle-search
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
whoogle-search/Dockerfile

104 lines
2.7 KiB
Docker
Raw Permalink Normal View History

Update Docker base images, update workflows Should fix issues with tomllib not being available in the docker related builds, as well as the move from docker-compose to "docker compose" in gh actions
2024-09-30 19:27:01 +03:00
FROM python:3.12.6-alpine3.20 AS builder
Added basic docker setup
2020-04-08 23:05:28 +03:00
Use alpine docker image (#573)
2021-12-19 21:59:06 +03:00
RUN apk --update add \
build-base \
Add docker buildx gh action This automatically builds and pushes a cross platform image to Docker Hub.
2021-01-06 01:53:58 +03:00
libxml2-dev \
libxslt-dev \
Use alpine docker image (#573)
2021-12-19 21:59:06 +03:00
openssl-dev \
Split crypto + pyopenssl reqs for armv7 builds Since including rust in the builder stage of the image didn't address the issues with building the cryptography library on armv7, that architecture will just use the last supported version of the affected libraries. May want to revisit this later.
2023-02-22 00:28:15 +03:00
libffi-dev
docker: Upgrade pip before installing requirements Outdated pip versions require a rust compiler to install the cryptography package. Ensuring that pip is up to date should eliminate the recent buildx errors where a prebuilt cryptography wheel is not available.
2021-12-22 00:26:01 +03:00
Improved Dockerfile
2020-05-10 15:00:22 +03: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 18:49:40 +03:00
docker: Upgrade pip before installing requirements Outdated pip versions require a rust compiler to install the cryptography package. Ensuring that pip is up to date should eliminate the recent buildx errors where a prebuilt cryptography wheel is not available.
2021-12-22 00:26:01 +03:00
RUN pip install --upgrade pip
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 18:49:40 +03:00
RUN pip install --prefix /install --no-warn-script-location --no-cache-dir -r requirements.txt
Update Docker base images, update workflows Should fix issues with tomllib not being available in the docker related builds, as well as the move from docker-compose to "docker compose" in gh actions
2024-09-30 19:27:01 +03:00
FROM python:3.12.6-alpine3.20
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 18:49:40 +03:00
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 23:14:56 +03:00
RUN apk add --update --no-cache tor curl openrc libstdc++
Optionally build obfs4proxy in docker (#1032)
2023-08-02 19:42:46 +03:00
# git go //for obfs4proxy
docker: Upgrade pip before installing requirements Outdated pip versions require a rust compiler to install the cryptography package. Ensuring that pip is up to date should eliminate the recent buildx errors where a prebuilt cryptography wheel is not available.
2021-12-22 00:26:01 +03:00
# libcurl4-openssl-dev
Improved Dockerfile
2020-05-10 15:00:22 +03:00
Remove bash dependency Depending on bash wasn't strictly necessary, as the two minimal scripts in the repo were both nearly POSIX anyways. Aside from simplifying the repo's dependencies a little bit, this also helps reduce the overall Docker image size as an added bonus.
2022-01-25 23:07:21 +03:00
RUN apk -U upgrade
Optionally build obfs4proxy in docker (#1032)
2023-08-02 19:42:46 +03:00
# uncomment to build obfs4proxy
# RUN git clone https://gitlab.com/yawning/obfs4.git
# WORKDIR /obfs4
# RUN go build -o obfs4proxy/obfs4proxy ./obfs4proxy
# RUN cp ./obfs4proxy/obfs4proxy /usr/bin/obfs4proxy
Run container as non-root `whoogle` user (#617) Creates a non-root user ("whoogle"), and runs the container as that user.
2022-01-21 23:51:51 +03:00
ARG DOCKER_USER=whoogle
ARG DOCKER_USERID=927
Added volume mounted config to Dockerfile (#39)
2020-05-14 03:27:04 +03:00
ARG config_dir=/config
[Docker] Split config dir creation/set permissions If the config dir already exists, setting the mode (`-m 777`) doesn't actually work as it should. This change splits the command into two separate commands for directory creation and enabling the directory to be writable by all. Fixes #658
2022-02-21 19:33:30 +03:00
RUN mkdir -p $config_dir
RUN chmod a+w $config_dir
Added volume mounted config to Dockerfile (#39)
2020-05-14 03:27:04 +03:00
VOLUME $config_dir
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-19 00:27:45 +03:00
ARG url_prefix=''
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 19:30:32 +03:00
ARG username=''
ARG 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 03:47:42 +03:00
ARG proxyuser=''
ARG proxypass=''
ARG proxytype=''
ARG 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 20:27:08 +03:00
ARG 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-16 00:44:50 +03:00
ARG use_https=''
ARG whoogle_port=5000
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 03:27:33 +03:00
ARG twitter_alt='farside.link/nitter'
ARG youtube_alt='farside.link/invidious'
ARG reddit_alt='farside.link/libreddit'
ARG medium_alt='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 19:08:52 +03:00
ARG translate_alt='farside.link/lingva'
ARG imgur_alt='farside.link/rimgo'
ARG wikipedia_alt='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 20:49:09 +03:00
ARG imdb_alt='farside.link/libremdb'
ARG quora_alt='farside.link/quetre'
Add SO as a default site alternative (#1168) SO -> farside.link/anonymousoverflow
2024-09-30 19:34:54 +03:00
ARG so_alt='farside.link/anonymousoverflow'
Use alpine docker image (#573)
2021-12-19 21:59:06 +03:00
ENV CONFIG_VOLUME=$config_dir \
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-19 00:27:45 +03:00
WHOOGLE_URL_PREFIX=$url_prefix \
Use alpine docker image (#573)
2021-12-19 21:59:06 +03:00
WHOOGLE_USER=$username \
WHOOGLE_PASS=$password \
WHOOGLE_PROXY_USER=$proxyuser \
WHOOGLE_PROXY_PASS=$proxypass \
WHOOGLE_PROXY_TYPE=$proxytype \
WHOOGLE_PROXY_LOC=$proxyloc \
WHOOGLE_DOTENV=$whoogle_dotenv \
HTTPS_ONLY=$use_https \
EXPOSE_PORT=$whoogle_port \
WHOOGLE_ALT_TW=$twitter_alt \
WHOOGLE_ALT_YT=$youtube_alt \
WHOOGLE_ALT_RD=$reddit_alt \
WHOOGLE_ALT_MD=$medium_alt \
Fix Dockerfile syntax errors
2022-01-14 20:05:24 +03:00
WHOOGLE_ALT_TL=$translate_alt \
WHOOGLE_ALT_IMG=$imgur_alt \
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 20:49:09 +03:00
WHOOGLE_ALT_WIKI=$wikipedia_alt \
WHOOGLE_ALT_IMDB=$imdb_alt \
Add SO as a default site alternative (#1168) SO -> farside.link/anonymousoverflow
2024-09-30 19:34:54 +03:00
WHOOGLE_ALT_QUORA=$quora_alt \
WHOOGLE_ALT_SO=$so_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-06 01:01:21 +03: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 18:49:40 +03: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 19:27:08 +03: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 18:49:40 +03:00
COPY app/ app/
Autoload `whoogle.env` if it exists The whoogle.env file previously needed to be created and enabled using the WHOOGLE_DOTENV var. This removes the second step and loads the env file if it's found during app init. The Dockerfile has also been updated to copy in whoogle.env if it exists. Fixes #909
2023-01-04 20:33:57 +03:00
COPY run whoogle.env* ./
Added basic docker setup
2020-04-08 23:05:28 +03:00
Run container as non-root `whoogle` user (#617) Creates a non-root user ("whoogle"), and runs the container as that user.
2022-01-21 23:51:51 +03:00
# Create user/group to run as
Remove bash dependency Depending on bash wasn't strictly necessary, as the two minimal scripts in the repo were both nearly POSIX anyways. Aside from simplifying the repo's dependencies a little bit, this also helps reduce the overall Docker image size as an added bonus.
2022-01-25 23:07:21 +03:00
RUN adduser -D -g $DOCKER_USERID -u $DOCKER_USERID $DOCKER_USER
Run container as non-root `whoogle` user (#617) Creates a non-root user ("whoogle"), and runs the container as that user.
2022-01-21 23:51:51 +03:00
# Fix ownership / permissions
[Docker] Split config dir creation/set permissions If the config dir already exists, setting the mode (`-m 777`) doesn't actually work as it should. This change splits the command into two separate commands for directory creation and enabling the directory to be writable by all. Fixes #658
2022-02-21 19:33:30 +03:00
RUN chown -R ${DOCKER_USER}:${DOCKER_USER} /whoogle /var/lib/tor
Run container as non-root `whoogle` user (#617) Creates a non-root user ("whoogle"), and runs the container as that user.
2022-01-21 23:51:51 +03:00
Remove bash dependency Depending on bash wasn't strictly necessary, as the two minimal scripts in the repo were both nearly POSIX anyways. Aside from simplifying the repo's dependencies a little bit, this also helps reduce the overall Docker image size as an added bonus.
2022-01-25 23:07:21 +03:00
# Allow writing symlinks to build dir
RUN chown $DOCKER_USERID:$DOCKER_USERID app/static/build
Run container as non-root `whoogle` user (#617) Creates a non-root user ("whoogle"), and runs the container as that user.
2022-01-21 23:51:51 +03:00
USER $DOCKER_USER:$DOCKER_USER
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-16 00:44:50 +03:00
EXPOSE $EXPOSE_PORT
Improved Dockerfile
2020-05-10 15:00:22 +03:00
Remove bash dependency Depending on bash wasn't strictly necessary, as the two minimal scripts in the repo were both nearly POSIX anyways. Aside from simplifying the repo's dependencies a little bit, this also helps reduce the overall Docker image size as an added bonus.
2022-01-25 23:07:21 +03: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 18:48:15 +03:00
CMD curl -f http://localhost:${EXPOSE_PORT}/healthz || exit 1
Add healthcheck to Dockerfile See #184
2021-03-08 20:38:40 +03: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 19:27:08 +03:00
CMD misc/tor/start-tor.sh & ./run