dd23ad8 · searx · git.iko.soy

git.iko.soy/searx

[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>

commitdd23ad8ba27133f0f3214e66459cd511f98a8bce authorMarkus Heiser <markus.heiser@darmarit.de> dateTue 27 Oct 2020, 17:06 (6 years ago) parentd553de4

3 files changed+33−33

compare with master

unifiedsplit

docs/build-templates/filtron.rst+10−10 docs/build-templates/morty.rst+10−10 docs/build-templates/searx.rst+13−13

docs/build-templates/filtron.rst+10−10

@@ -7,11 +7,11 @@

77 .. code-block:: sh

99 $ sudo -H useradd --shell /bin/bash --system \\

10− --home-dir "$SERVICE_HOME" \\

11− --comment "Privacy-respecting metasearch engine" $SERVICE_USER

10+ --home-dir \"$SERVICE_HOME\" \\

11+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER

1212

13− $ sudo -H mkdir "$SERVICE_HOME"

14− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"

13+ $ sudo -H mkdir \"$SERVICE_HOME\"

14+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"

1515

1616.. END create user

1717

@@ -23,16 +23,16 @@

2323

2424 .. code-block:: bash

2525

26− $ cat > "$GO_ENV" <<EOF

26+ $ cat > \"$GO_ENV\" <<EOF

2727 export GOPATH=${SERVICE_HOME}/go-apps

2828 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin

2929 EOF

30− $ sudo -i -u "${SERVICE_USER}"

30+ $ sudo -i -u \"${SERVICE_USER}\"

3131 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile

3232 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local

33− (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\

34− "${GO_PKG_URL}"

35− (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf "${GO_TAR}"

33+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\

34+ \"${GO_PKG_URL}\"

35+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf \"${GO_TAR}\"

3636 (${SERVICE_USER}) $ which go

3737 ${SERVICE_HOME}/local/go/bin/go

3838

@@ -46,7 +46,7 @@

4646

4747 .. code-block:: bash

4848

49− $ sudo -i -u "${SERVICE_USER}"

49+ $ sudo -i -u \"${SERVICE_USER}\"

5050 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/filtron

5151

5252.. END install filtron

docs/build-templates/morty.rst+10−10

@@ -7,11 +7,11 @@

77 .. code-block:: sh

99 $ sudo -H useradd --shell /bin/bash --system \\

10− --home-dir "$SERVICE_HOME" \\

11− --comment "Privacy-respecting metasearch engine" $SERVICE_USER

10+ --home-dir \"$SERVICE_HOME\" \\

11+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER

1212

13− $ sudo -H mkdir "$SERVICE_HOME"

14− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"

13+ $ sudo -H mkdir \"$SERVICE_HOME\"

14+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"

1515

1616.. END create user

1717

@@ -23,16 +23,16 @@

2323

2424 .. code-block:: bash

2525

26− $ cat > "$GO_ENV" <<EOF

26+ $ cat > \"$GO_ENV\" <<EOF

2727 export GOPATH=${SERVICE_HOME}/go-apps

2828 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin

2929 EOF

30− $ sudo -i -u "${SERVICE_USER}"

30+ $ sudo -i -u \"${SERVICE_USER}\"

3131 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile

3232 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local

33− (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\

34− "${GO_PKG_URL}"

35− (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf "${GO_TAR}"

33+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\

34+ \"${GO_PKG_URL}\"

35+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf \"${GO_TAR}\"

3636 (${SERVICE_USER}) $ which go

3737 ${SERVICE_HOME}/local/go/bin/go

3838

@@ -46,7 +46,7 @@

4646

4747 .. code-block:: bash

4848

49− $ sudo -i -u "${SERVICE_USER}"

49+ $ sudo -i -u \"${SERVICE_USER}\"

5050 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/morty

5151

5252.. END install morty

docs/build-templates/searx.rst+13−13

@@ -64,11 +64,11 @@ ${fedora_build}

6464 .. code-block:: sh

6565

6666 $ sudo -H useradd --shell /bin/bash --system \\

67− --home-dir "$SERVICE_HOME" \\

67+ --home-dir \"$SERVICE_HOME\" \\

6868 --comment 'Privacy-respecting metasearch engine' $SERVICE_USER

6969

70− $ sudo -H mkdir "$SERVICE_HOME"

71− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"

70+ $ sudo -H mkdir \"$SERVICE_HOME\"

71+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"

7272

7373.. END create user

7474

@@ -81,7 +81,7 @@ ${fedora_build}

8181 .. code-block:: sh

8282

8383 $ sudo -H -u ${SERVICE_USER} -i

84− (${SERVICE_USER})$ git clone "https://github.com/searx/searx.git" "$SEARX_SRC"

84+ (${SERVICE_USER})$ git clone \"https://github.com/searx/searx.git\" \"$SEARX_SRC\"

8585

8686.. END clone searx

8787

@@ -93,8 +93,8 @@ ${fedora_build}

9393

9494 .. code-block:: sh

9595

96− (${SERVICE_USER})$ python3 -m venv "${SEARX_PYENV}"

97− (${SERVICE_USER})$ echo ". ${SEARX_PYENV}/bin/activate" >> "$SERVICE_HOME/.profile"

96+ (${SERVICE_USER})$ python3 -m venv \"${SEARX_PYENV}\"

97+ (${SERVICE_USER})$ echo \". ${SEARX_PYENV}/bin/activate\" >> \"$SERVICE_HOME/.profile\"

9898

9999.. END create virtualenv

100100

@@ -118,7 +118,7 @@ ${fedora_build}

118118 pip install -U wheel

119119

120120 # jump to searx's working tree and install searx into virtualenv

121− (${SERVICE_USER})$ cd "$SEARX_SRC"

121+ (${SERVICE_USER})$ cd \"$SEARX_SRC\"

122122 (${SERVICE_USER})$ pip install -e .

123123

124124

@@ -132,9 +132,9 @@ ${fedora_build}

132132

133133 .. code-block:: sh

134134

135− $ sudo -H cp "$SEARX_SRC/searx/settings.yml" "${SEARX_SETTINGS_PATH}"

136− $ sudo -H sed -i -e "s/ultrasecretkey/\\$(openssl rand -hex 16)/g" "$SEARX_SETTINGS_PATH"

137− $ sudo -H sed -i -e "s/{instance_name}/searx@\\$(uname -n)/g" "$SEARX_SETTINGS_PATH"

135+ $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \"${SEARX_SETTINGS_PATH}\"

136+ $ sudo -H sed -i -e \"s/ultrasecretkey/\\$(openssl rand -hex 16)/g\" \"$SEARX_SETTINGS_PATH\"

137+ $ sudo -H sed -i -e \"s/{instance_name}/searx@\\$(uname -n)/g\" \"$SEARX_SETTINGS_PATH\"

138138

139139.. END searx config

140140

@@ -147,16 +147,16 @@ ${fedora_build}

147147 .. code-block:: sh

148148

149149 # enable debug ..

150− $ sudo -H sed -i -e "s/debug : False/debug : True/g" "$SEARX_SETTINGS_PATH"

150+ $ sudo -H sed -i -e \"s/debug : False/debug : True/g\" \"$SEARX_SETTINGS_PATH\"

151151

152152 # start webapp

153153 $ sudo -H -u ${SERVICE_USER} -i

154154 (${SERVICE_USER})$ cd ${SEARX_SRC}

155− (${SERVICE_USER})$ export SEARX_SETTINGS_PATH="${SEARX_SETTINGS_PATH}"

155+ (${SERVICE_USER})$ export SEARX_SETTINGS_PATH=\"${SEARX_SETTINGS_PATH}\"

156156 (${SERVICE_USER})$ python searx/webapp.py

157157

158158 # disable debug

159− $ sudo -H sed -i -e "s/debug : True/debug : False/g" "$SEARX_SETTINGS_PATH"

159+ $ sudo -H sed -i -e \"s/debug : True/debug : False/g\" \"$SEARX_SETTINGS_PATH\"

160160

161161Open WEB browser and visit http://$SEARX_INTERNAL_URL . If you are inside a

162162container or in a script, test with curl: