From d6c321b830aa028cb6a003bebe52e2c24d26b7eb Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 10 May 2021 11:26:56 +0200 Subject: [PATCH 1/3] [mod] docker-entrypoint.sh - add script to make test.sh (shellcheck) Add script docker-entrypoint.sh to shellcheck and try to _simplify_ and _normalize_ some parts: - fix issues reported by shellcheck - don't mix tab and space indent - command 'help' replaced by '-h': ./dockerfiles/docker-entrypoint.sh -h - replace printf in help() by 'cat < --- Makefile | 2 + dockerfiles/docker-entrypoint.sh | 142 +++++++++++++++-------------- docs/admin/installation-docker.rst | 2 +- 3 files changed, 76 insertions(+), 70 deletions(-) diff --git a/Makefile b/Makefile index 2d760c496..c2c9cf49e 100644 --- a/Makefile +++ b/Makefile @@ -54,6 +54,8 @@ PHONY += test ci.test test.shell ci.test: test.pep8 test.pylint test.unit test.robot test: test.pep8 test.pylint test.unit test.robot test.shell test.shell: + $(Q)shellcheck -x -s dash \ + dockerfiles/docker-entrypoint.sh $(Q)shellcheck -x -s bash \ utils/brand.env \ ./manage \ diff --git a/dockerfiles/docker-entrypoint.sh b/dockerfiles/docker-entrypoint.sh index 1d8edad13..d5c4d5fea 100755 --- a/dockerfiles/docker-entrypoint.sh +++ b/dockerfiles/docker-entrypoint.sh @@ -1,62 +1,66 @@ #!/bin/sh help() { - printf "Command line:\n\n" - printf " -h Display this help\n" - printf " -d Dry run to update the configuration files.\n" - printf " -f Always update on the configuration files (existing files are renamed with the .old suffix)\n" - printf " Without this option, the new configuration files are copied with the .new suffix\n" - printf "\nEnvironment variables:\n\n" - printf " INSTANCE_NAME settings.yml : general.instance_name\n" - printf " AUTOCOMPLETE settings.yml : search.autocomplete\n" - printf " BASE_URL settings.yml : server.base_url\n" - printf " MORTY_URL settings.yml : result_proxy.url\n" - printf " MORTY_KEY settings.yml : result_proxy.key\n" - printf " BIND_ADDRESS uwsgi bind to the specified TCP socket using HTTP protocol. Default value: \"${DEFAULT_BIND_ADDRESS}\"\n" - printf "\nVolume:\n\n" - printf " /etc/searx the docker entry point copies settings.yml and uwsgi.ini in this directory (see the -f command line option)\n" - echo - exit 0 + cat </dev/null) -printf 'searx version %s\n\n' "${SEARX_VERSION}" +export BIND_ADDRESS="${BIND_ADDRESS:-${DEFAULT_BIND_ADDRESS}}" # Parse command line FORCE_CONF_UPDATE=0 DRY_RUN=0 + while getopts "fdh" option do case $option in - f) - FORCE_CONF_UPDATE=1 - ;; - d) - DRY_RUN=1 - ;; - h) - help + + f) FORCE_CONF_UPDATE=1 ;; + d) DRY_RUN=1 ;; + + h) + help + exit 0 + ;; + *) + echo "unknow option ${option}" + exit 42 + ;; esac done +get_searx_version(){ + su searx -c \ + 'python3 -c "import six; import searx.version; six.print_(searx.version.VERSION_STRING)"' \ + 2>/dev/null +} + +SEARX_VERSION="$(get_searx_version)" +export SEARX_VERSION +echo "searx version ${SEARX_VERSION}" + # helpers to update the configuration files patch_uwsgi_settings() { CONF="$1" - - # Nothing } patch_searx_settings() { @@ -74,10 +78,11 @@ patch_searx_settings() { "${CONF}" # Morty configuration - if [ ! -z "${MORTY_KEY}" -a ! -z "${MORTY_URL}" ]; then - sed -i -e "s/image_proxy : False/image_proxy : True/g" \ - "${CONF}" - cat >> "${CONF}" <<-EOF + + if [ -n "${MORTY_KEY}" ] && [ -n "${MORTY_URL}" ]; then + sed -i -e "s/image_proxy : False/image_proxy : True/g" \ + "${CONF}" + cat >> "${CONF}" <<-EOF # Morty configuration result_proxy: @@ -96,35 +101,35 @@ update_conf() { PATCH_REF_CONF="$4" if [ -f "${CONF}" ]; then - if [ "${REF_CONF}" -nt "${CONF}" ]; then - # There is a new version - if [ $FORCE_CONF_UPDATE -ne 0 ]; then - # Replace the current configuration - printf '⚠️ Automaticaly update %s to the new version\n' "${CONF}" - if [ ! -f "${OLD_CONF}" ]; then - printf 'The previous configuration is saved to %s\n' "${OLD_CONF}" - mv "${CONF}" "${OLD_CONF}" - fi - cp "${REF_CONF}" "${CONF}" - $PATCH_REF_CONF "${CONF}" - else - # Keep the current configuration - printf '⚠️ Check new version %s to make sure searx is working properly\n' "${NEW_CONF}" - cp "${REF_CONF}" "${NEW_CONF}" - $PATCH_REF_CONF "${NEW_CONF}" - fi - else - printf 'Use existing %s\n' "${CONF}" - fi + if [ "${REF_CONF}" -nt "${CONF}" ]; then + # There is a new version + if [ "$FORCE_CONF_UPDATE" -ne 0 ]; then + # Replace the current configuration + printf '⚠️ Automaticaly update %s to the new version\n' "${CONF}" + if [ ! -f "${OLD_CONF}" ]; then + printf 'The previous configuration is saved to %s\n' "${OLD_CONF}" + mv "${CONF}" "${OLD_CONF}" + fi + cp "${REF_CONF}" "${CONF}" + $PATCH_REF_CONF "${CONF}" + else + # Keep the current configuration + printf '⚠️ Check new version %s to make sure searx is working properly\n' "${NEW_CONF}" + cp "${REF_CONF}" "${NEW_CONF}" + $PATCH_REF_CONF "${NEW_CONF}" + fi + else + printf 'Use existing %s\n' "${CONF}" + fi else - printf 'Create %s\n' "${CONF}" - cp "${REF_CONF}" "${CONF}" - $PATCH_REF_CONF "${CONF}" + printf 'Create %s\n' "${CONF}" + cp "${REF_CONF}" "${CONF}" + $PATCH_REF_CONF "${CONF}" fi } # make sure there are uwsgi settings -update_conf ${FORCE_CONF_UPDATE} "${UWSGI_SETTINGS_PATH}" "/usr/local/searx/dockerfiles/uwsgi.ini" "patch_uwsgi_settings" +update_conf "${FORCE_CONF_UPDATE}" "${UWSGI_SETTINGS_PATH}" "/usr/local/searx/dockerfiles/uwsgi.ini" "patch_uwsgi_settings" # make sure there are searx settings update_conf "${FORCE_CONF_UPDATE}" "${SEARX_SETTINGS_PATH}" "/usr/local/searx/searx/settings.yml" "patch_searx_settings" @@ -135,7 +140,6 @@ if [ $DRY_RUN -eq 1 ]; then exit fi -# touch /var/run/uwsgi-logrotate chown -R searx:searx /var/log/uwsgi /var/run/uwsgi-logrotate unset MORTY_KEY diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index 120c9cb08..7e40546c6 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -39,7 +39,7 @@ Command line docker run --rm -it searxng/searxng -h -.. program-output:: ../dockerfiles/docker-entrypoint.sh help +.. program-output:: ../dockerfiles/docker-entrypoint.sh -h Build the image From 12b55320eaac6551e885852966afd6413715ee4c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 29 Apr 2021 14:33:35 +0200 Subject: [PATCH 2/3] [doc] docker: revision and preparation of the documentation - add sidebars with addition infos about commands and docker in general - fix long lines & indentation - correct link to https://github.com/searxng/searxng-docker Signed-off-by: Markus Heiser --- docs/admin/installation-docker.rst | 179 +++++++++++++++++++++++------ 1 file changed, 145 insertions(+), 34 deletions(-) diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index 7e40546c6..750d41679 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -1,60 +1,171 @@ + .. _installation docker: =================== Docker installation =================== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry +.. _ENTRYPOINT: https://docs.docker.com/engine/reference/builder/#entrypoint +.. _searxng-docker: https://github.com/searxng/searxng-docker +.. _[filtron]: https://hub.docker.com/r/dalf/filtron +.. _[morty]: https://hub.docker.com/r/dalf/morty +.. _[caddy]: https://hub.docker.com/_/caddy ----- +.. sidebar:: info -Docker image searxng/searxng -============================ + - :origin:`Dockerfile` + - `searxng/searxng @dockerhub `_ + - `Docker overview `_ + - `Docker Cheat Sheet `_ + - `Alpine Linux `_ `(wiki) `__ `apt packages `_ + - Alpine's ``/bin/sh`` is :man:`dash` +.. tip:: -The docker image is `searxng/searxng `_ (based on `github.com/searxng/searxng `_). + If you intend to create a public instance using Docker, use our well + maintained searxng-docker_ image which includes -Make sure you have `installed Docker `_. For instance, you can deploy a local instance: + - :ref:`protection ` `[filtron]`_, + - a :ref:`result proxy ` `[morty]`_ and + - a HTTPS reverse proxy `[caddy]`_. + +Make sure you have `installed Docker `_ and +on Linux, don't forget to add your user to the docker group (log out and log +back in so that your group membership is re-evaluated): .. code:: sh - export PORT=80 - docker pull searxng/searxng - docker run --rm -d -v ${PWD}/searx:/etc/searx -p $PORT:8080 -e BASE_URL=http://localhost:$PORT/ searxng/searxng + $ sudo usermod -a -G docker $USER -Go to ``http://localhost:$PORT``. -Inside ``${PWD}/searx``, you will find ``settings.yml`` and ``uwsgi.ini``. -You can modify these files according to your needs and restart the Docker image. +searxng/searxng +=============== + +.. sidebar:: ``docker run`` + + - `-\-rm `__ + automatically clean up when container exits + - `-d `__ start + detached container + - `-v `__ + mount volume ``HOST:CONTAINER`` + +The docker image is based on :origin:`Dockerfile` and available from +`searxng/searxng @dockerhub`_. Using the docker image is quite easy, for +instance you can pull the `searxng/searxng @dockerhub`_ image and deploy a local +instance using `docker run `_: + +.. code:: sh + + $ mkdir my-instance + $ cd my-instance + $ export PORT=8080 + $ docker pull searxng/searxng + $ docker run --rm \ + -d -p ${PORT}:8080 \ + -v "${PWD}/searx:/etc/searx" \ + -e "BASE_URL=http://localhost:$PORT/" \ + -e "INSTANCE_NAME=my-instance" \ + searxng/searxng + 2f998.... # container's ID + +Open your WEB browser and visit the URL: + +.. code:: sh + + $ xdg-open "http://localhost:$PORT" + +Inside ``${PWD}/searx``, you will find ``settings.yml`` and ``uwsgi.ini``. You +can modify these files according to your needs and restart the Docker image. + +.. code:: sh + + $ docker container restart 2f998 + +Use command ``container ls`` to list running containers, add flag `-a +`__ to list +exited containers also. With ``container stop`` a running container can be +stoped. To get rid of a container use ``container rm``: + +.. code:: sh + + $ docker container ls + CONTAINER ID IMAGE COMMAND CREATED ... + 2f998d725993 searxng/searxng "/sbin/tini -- /usr/…" 7 minutes ago ... + + $ docker container stop 2f998 + $ docker container rm 2f998 + +.. sidebar:: Warning + + This might remove all docker items, not only those from searxng. + +If you won't use docker anymore and want to get rid of all conatiners & images +use the following *prune* command: + +.. code:: sh + + $ docker stop $(docker ps -aq) # stop all containers + $ docker system prune # make some housekeeping + $ docker rmi -f $(docker images -q) # drop all images + + +shell inside container +---------------------- + +.. sidebar:: Bashism + + - `A tale of two shells: bash or dash `_ + - `How to make bash scripts work in dash `_ + - `Checking for Bashisms `_ + +Like in many other distributions, Alpine's `/bin/sh +`__ is :man:`dash`. Dash is meant to be +`POSIX-compliant `__. +Compared to debian, in the Alpine image :man:`bash` is not installed. The +:origin:`dockerfiles/docker-entrypoint.sh` script is checked *against dash* +(``make tests.shell``). + +To open a shell inside the container: + +.. code:: sh + + $ docker exec -it 2f998 sh + + +Build the image +=============== + +It's also possible to build SearXNG from the embedded :origin:`Dockerfile`:: + + $ git clone https://github.com/searxng/searxng.git + $ cd searx + $ make docker.build + ... + Successfully built 49586c016434 + Successfully tagged searxng/searxng:latest + Successfully tagged searxng/searxng:1.0.0-209-9c823800-dirty + + $ docker images + REPOSITORY TAG IMAGE ID CREATED SIZE + searxng/searxng 1.0.0-209-9c823800-dirty 49586c016434 13 minutes ago 308MB + searxng/searxng latest 49586c016434 13 minutes ago 308MB + alpine 3.13 6dbb9cc54074 3 weeks ago 5.61MB Command line ------------- +============ +.. sidebar:: docker run + + Use flags ``-it`` for `interactive processes + `__. + +In the :origin:`Dockerfile` the ENTRYPOINT_ is defined as +:origin:`dockerfiles/docker-entrypoint.sh` .. code:: sh docker run --rm -it searxng/searxng -h .. program-output:: ../dockerfiles/docker-entrypoint.sh -h - - -Build the image ---------------- - -It's also possible to build SearXNG from the embedded Dockerfile. - -.. code:: sh - - git clone https://github.com/searxng/searxng.git - cd searx - make docker.build - - -Public instance -=============== - -If you intend to create a public instance using Docker, see https://github.com/searx/searx-docker From 130e58f982d1b8f471f2637faca77ae5a0bcb0b6 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 12 May 2021 16:45:44 +0200 Subject: [PATCH 3/3] [brand] Dockerfile default INSTANCE_NAME=searxng Signed-off-by: Markus Heiser --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 489e4397f..7ad892bb2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,7 +10,7 @@ ARG SEARX_UID=977 RUN addgroup -g ${SEARX_GID} searx && \ adduser -u ${SEARX_UID} -D -h /usr/local/searx -s /bin/sh -G searx searx -ENV INSTANCE_NAME=searx \ +ENV INSTANCE_NAME=searxng \ AUTOCOMPLETE= \ BASE_URL= \ MORTY_KEY= \