summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDalf <alex@al-f.net>2020-07-22 14:58:04 +0200
committerDalf <alex@al-f.net>2020-07-22 14:58:04 +0200
commit4a35975b427b3ebee4f5cc54e2390356b0102536 (patch)
tree6bd79a0f0b40ebba1c7ff6d4fcd6529df7e52ac7 /docs
parent7ef62c628424718f10b88a5850f7b4e92b2f7196 (diff)
downloadsearxng-4a35975b427b3ebee4f5cc54e2390356b0102536.tar.gz
searxng-4a35975b427b3ebee4f5cc54e2390356b0102536.zip
[enh] update documentation about docker
Diffstat (limited to 'docs')
-rw-r--r--docs/admin/installation-docker.rst44
1 files changed, 38 insertions, 6 deletions
diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst
index 340e66319..9510ded09 100644
--- a/docs/admin/installation-docker.rst
+++ b/docs/admin/installation-docker.rst
@@ -9,20 +9,52 @@ Docker installation
:local:
:backlinks: entry
-Make sure you have installed Docker. For instance, you can deploy searx like this:
+----
+
+Docker image searx/searx
+========================
+
+
+The docker image is `searx/searx <https://hub.docker.com/r/searx/searx>`_ (based on `github.com/searx/searx <https://github.com/searx/searx>`_).
+
+Make sure you have `installed Docker <https://docs.docker.com/get-docker/>`_. For instance, you can deploy a local instance:
.. code:: sh
- docker pull wonderfall/searx
- docker run -d --name searx -p $PORT:8888 wonderfall/searx
+ export PORT=80
+ docker pull searx/searx
+ docker run --rm -d -v ${PWD}/searx:/etc/searx -p $PORT:8080 -e BASE_URL=http://localhost:$PORT/ searx/searx
Go to ``http://localhost:$PORT``.
-See https://hub.docker.com/r/wonderfall/searx/ for more informations. It's also
-possible to build searx from the embedded Dockerfile.
+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.
+
+
+Command line
+------------
+
+
+.. code:: sh
+
+ docker run --rm -it searx/searx -h
+
+.. program-output:: ../dockerfiles/docker-entrypoint.sh -h
+
+
+Build the image
+---------------
+
+It's also possible to build searx from the embedded Dockerfile.
.. code:: sh
git clone https://github.com/asciimoo/searx.git
cd searx
- docker build -t whatever/searx .
+ make docker
+
+
+Public instance
+===============
+
+If you intend to create a public instance using Docker, see https://github.com/searx/searx-docker