summaryrefslogtreecommitdiff
path: root/docs/build-templates
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-10-27 17:06:37 +0100
committerAlexandre Flament <alex@al-f.net>2020-11-02 10:02:59 +0100
commitdd23ad8ba27133f0f3214e66459cd511f98a8bce (patch)
treee0bdd295257a79b64a2630cf336545f7f2080894 /docs/build-templates
parentd553de4909310fbd6666b58edb00c2777c928235 (diff)
downloadsearxng-dd23ad8ba27133f0f3214e66459cd511f98a8bce.tar.gz
searxng-dd23ad8ba27133f0f3214e66459cd511f98a8bce.zip
[fix] doc - add missing quotation marks in docs/build-templates
Escape the all the quotation marks (" --> \") in docs/build-templates. The scripts are *bash evaluated* (e.g):: eval "echo \"$(< "${REPO_ROOT}/docs/build-templates/searx.rst")\"" Backslash, quotation marks and other need to be escaped. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/build-templates')
-rw-r--r--docs/build-templates/filtron.rst20
-rw-r--r--docs/build-templates/morty.rst20
-rw-r--r--docs/build-templates/searx.rst26
3 files changed, 33 insertions, 33 deletions
diff --git a/docs/build-templates/filtron.rst b/docs/build-templates/filtron.rst
index 643688ff7..79b254399 100644
--- a/docs/build-templates/filtron.rst
+++ b/docs/build-templates/filtron.rst
@@ -7,11 +7,11 @@
.. code-block:: sh
$ sudo -H useradd --shell /bin/bash --system \\
- --home-dir "$SERVICE_HOME" \\
- --comment "Privacy-respecting metasearch engine" $SERVICE_USER
+ --home-dir \"$SERVICE_HOME\" \\
+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER
- $ sudo -H mkdir "$SERVICE_HOME"
- $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
+ $ sudo -H mkdir \"$SERVICE_HOME\"
+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
.. END create user
@@ -23,16 +23,16 @@
.. code-block:: bash
- $ cat > "$GO_ENV" <<EOF
+ $ cat > \"$GO_ENV\" <<EOF
export GOPATH=${SERVICE_HOME}/go-apps
export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
EOF
- $ sudo -i -u "${SERVICE_USER}"
+ $ sudo -i -u \"${SERVICE_USER}\"
(${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
(${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
- (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\
- "${GO_PKG_URL}"
- (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf "${GO_TAR}"
+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\
+ \"${GO_PKG_URL}\"
+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf \"${GO_TAR}\"
(${SERVICE_USER}) $ which go
${SERVICE_HOME}/local/go/bin/go
@@ -46,7 +46,7 @@
.. code-block:: bash
- $ sudo -i -u "${SERVICE_USER}"
+ $ sudo -i -u \"${SERVICE_USER}\"
(${SERVICE_USER}) $ go get -v -u github.com/asciimoo/filtron
.. END install filtron
diff --git a/docs/build-templates/morty.rst b/docs/build-templates/morty.rst
index 4a5d1f27f..092f9f68f 100644
--- a/docs/build-templates/morty.rst
+++ b/docs/build-templates/morty.rst
@@ -7,11 +7,11 @@
.. code-block:: sh
$ sudo -H useradd --shell /bin/bash --system \\
- --home-dir "$SERVICE_HOME" \\
- --comment "Privacy-respecting metasearch engine" $SERVICE_USER
+ --home-dir \"$SERVICE_HOME\" \\
+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER
- $ sudo -H mkdir "$SERVICE_HOME"
- $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
+ $ sudo -H mkdir \"$SERVICE_HOME\"
+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
.. END create user
@@ -23,16 +23,16 @@
.. code-block:: bash
- $ cat > "$GO_ENV" <<EOF
+ $ cat > \"$GO_ENV\" <<EOF
export GOPATH=${SERVICE_HOME}/go-apps
export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
EOF
- $ sudo -i -u "${SERVICE_USER}"
+ $ sudo -i -u \"${SERVICE_USER}\"
(${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
(${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
- (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\
- "${GO_PKG_URL}"
- (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf "${GO_TAR}"
+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\
+ \"${GO_PKG_URL}\"
+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf \"${GO_TAR}\"
(${SERVICE_USER}) $ which go
${SERVICE_HOME}/local/go/bin/go
@@ -46,7 +46,7 @@
.. code-block:: bash
- $ sudo -i -u "${SERVICE_USER}"
+ $ sudo -i -u \"${SERVICE_USER}\"
(${SERVICE_USER}) $ go get -v -u github.com/asciimoo/morty
.. END install morty
diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst
index 5a65488b0..841dec3ad 100644
--- a/docs/build-templates/searx.rst
+++ b/docs/build-templates/searx.rst
@@ -64,11 +64,11 @@ ${fedora_build}
.. code-block:: sh
$ sudo -H useradd --shell /bin/bash --system \\
- --home-dir "$SERVICE_HOME" \\
+ --home-dir \"$SERVICE_HOME\" \\
--comment 'Privacy-respecting metasearch engine' $SERVICE_USER
- $ sudo -H mkdir "$SERVICE_HOME"
- $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
+ $ sudo -H mkdir \"$SERVICE_HOME\"
+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
.. END create user
@@ -81,7 +81,7 @@ ${fedora_build}
.. code-block:: sh
$ sudo -H -u ${SERVICE_USER} -i
- (${SERVICE_USER})$ git clone "https://github.com/searx/searx.git" "$SEARX_SRC"
+ (${SERVICE_USER})$ git clone \"https://github.com/searx/searx.git\" \"$SEARX_SRC\"
.. END clone searx
@@ -93,8 +93,8 @@ ${fedora_build}
.. code-block:: sh
- (${SERVICE_USER})$ python3 -m venv "${SEARX_PYENV}"
- (${SERVICE_USER})$ echo ". ${SEARX_PYENV}/bin/activate" >> "$SERVICE_HOME/.profile"
+ (${SERVICE_USER})$ python3 -m venv \"${SEARX_PYENV}\"
+ (${SERVICE_USER})$ echo \". ${SEARX_PYENV}/bin/activate\" >> \"$SERVICE_HOME/.profile\"
.. END create virtualenv
@@ -118,7 +118,7 @@ ${fedora_build}
pip install -U wheel
# jump to searx's working tree and install searx into virtualenv
- (${SERVICE_USER})$ cd "$SEARX_SRC"
+ (${SERVICE_USER})$ cd \"$SEARX_SRC\"
(${SERVICE_USER})$ pip install -e .
@@ -132,9 +132,9 @@ ${fedora_build}
.. code-block:: sh
- $ sudo -H cp "$SEARX_SRC/searx/settings.yml" "${SEARX_SETTINGS_PATH}"
- $ sudo -H sed -i -e "s/ultrasecretkey/\\$(openssl rand -hex 16)/g" "$SEARX_SETTINGS_PATH"
- $ sudo -H sed -i -e "s/{instance_name}/searx@\\$(uname -n)/g" "$SEARX_SETTINGS_PATH"
+ $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \"${SEARX_SETTINGS_PATH}\"
+ $ sudo -H sed -i -e \"s/ultrasecretkey/\\$(openssl rand -hex 16)/g\" \"$SEARX_SETTINGS_PATH\"
+ $ sudo -H sed -i -e \"s/{instance_name}/searx@\\$(uname -n)/g\" \"$SEARX_SETTINGS_PATH\"
.. END searx config
@@ -147,16 +147,16 @@ ${fedora_build}
.. code-block:: sh
# enable debug ..
- $ sudo -H sed -i -e "s/debug : False/debug : True/g" "$SEARX_SETTINGS_PATH"
+ $ sudo -H sed -i -e \"s/debug : False/debug : True/g\" \"$SEARX_SETTINGS_PATH\"
# start webapp
$ sudo -H -u ${SERVICE_USER} -i
(${SERVICE_USER})$ cd ${SEARX_SRC}
- (${SERVICE_USER})$ export SEARX_SETTINGS_PATH="${SEARX_SETTINGS_PATH}"
+ (${SERVICE_USER})$ export SEARX_SETTINGS_PATH=\"${SEARX_SETTINGS_PATH}\"
(${SERVICE_USER})$ python searx/webapp.py
# disable debug
- $ sudo -H sed -i -e "s/debug : True/debug : False/g" "$SEARX_SETTINGS_PATH"
+ $ sudo -H sed -i -e \"s/debug : True/debug : False/g\" \"$SEARX_SETTINGS_PATH\"
Open WEB browser and visit http://$SEARX_INTERNAL_URL . If you are inside a
container or in a script, test with curl: