on master help sign in
[fix] doc - add missing quotation marks in docs/build-templates
dd23ad8Markus Heiser
docs/build-templates/filtron.rst+10−10
@@ -7,11 +7,11 @@
7 .. code-block:: sh
7 .. code-block:: sh
8
8
9 $ sudo -H useradd --shell /bin/bash --system \\
9 $ sudo -H useradd --shell /bin/bash --system \\
10− --home-dir "$SERVICE_HOME" \\
10+ --home-dir \"$SERVICE_HOME\" \\
11− --comment "Privacy-respecting metasearch engine" $SERVICE_USER
11+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER
12
12
13− $ sudo -H mkdir "$SERVICE_HOME"
13+ $ sudo -H mkdir \"$SERVICE_HOME\"
14− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
14+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
15
15
16.. END create user
16.. END create user
17
17
@@ -23,16 +23,16 @@
23
23
24 .. code-block:: bash
24 .. code-block:: bash
25
25
26− $ cat > "$GO_ENV" <<EOF
26+ $ cat > \"$GO_ENV\" <<EOF
27 export GOPATH=${SERVICE_HOME}/go-apps
27 export GOPATH=${SERVICE_HOME}/go-apps
28 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
28 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
29 EOF
29 EOF
30− $ sudo -i -u "${SERVICE_USER}"
30+ $ sudo -i -u \"${SERVICE_USER}\"
31 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
31 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
32 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
32 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
33− (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\
33+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\
34− "${GO_PKG_URL}"
34+ \"${GO_PKG_URL}\"
35− (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf "${GO_TAR}"
35+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local -xzf \"${GO_TAR}\"
36 (${SERVICE_USER}) $ which go
36 (${SERVICE_USER}) $ which go
37 ${SERVICE_HOME}/local/go/bin/go
37 ${SERVICE_HOME}/local/go/bin/go
38
38
@@ -46,7 +46,7 @@
46
46
47 .. code-block:: bash
47 .. code-block:: bash
48
48
49− $ sudo -i -u "${SERVICE_USER}"
49+ $ sudo -i -u \"${SERVICE_USER}\"
50 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/filtron
50 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/filtron
51
51
52.. END install filtron
52.. END install filtron
docs/build-templates/morty.rst+10−10
@@ -7,11 +7,11 @@
7 .. code-block:: sh
7 .. code-block:: sh
8
8
9 $ sudo -H useradd --shell /bin/bash --system \\
9 $ sudo -H useradd --shell /bin/bash --system \\
10− --home-dir "$SERVICE_HOME" \\
10+ --home-dir \"$SERVICE_HOME\" \\
11− --comment "Privacy-respecting metasearch engine" $SERVICE_USER
11+ --comment \"Privacy-respecting metasearch engine\" $SERVICE_USER
12
12
13− $ sudo -H mkdir "$SERVICE_HOME"
13+ $ sudo -H mkdir \"$SERVICE_HOME\"
14− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
14+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
15
15
16.. END create user
16.. END create user
17
17
@@ -23,16 +23,16 @@
23
23
24 .. code-block:: bash
24 .. code-block:: bash
25
25
26− $ cat > "$GO_ENV" <<EOF
26+ $ cat > \"$GO_ENV\" <<EOF
27 export GOPATH=${SERVICE_HOME}/go-apps
27 export GOPATH=${SERVICE_HOME}/go-apps
28 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
28 export PATH=\$PATH:${SERVICE_HOME}/local/go/bin:\$GOPATH/bin
29 EOF
29 EOF
30− $ sudo -i -u "${SERVICE_USER}"
30+ $ sudo -i -u \"${SERVICE_USER}\"
31 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
31 (${SERVICE_USER}) $ echo 'source $GO_ENV' >> ~/.profile
32 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
32 (${SERVICE_USER}) $ mkdir ${SERVICE_HOME}/local
33− (${SERVICE_USER}) $ wget --progress=bar -O "${GO_TAR}" \\
33+ (${SERVICE_USER}) $ wget --progress=bar -O \"${GO_TAR}\" \\
34− "${GO_PKG_URL}"
34+ \"${GO_PKG_URL}\"
35− (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf "${GO_TAR}"
35+ (${SERVICE_USER}) $ tar -C ${SERVICE_HOME}/local/go -xzf \"${GO_TAR}\"
36 (${SERVICE_USER}) $ which go
36 (${SERVICE_USER}) $ which go
37 ${SERVICE_HOME}/local/go/bin/go
37 ${SERVICE_HOME}/local/go/bin/go
38
38
@@ -46,7 +46,7 @@
46
46
47 .. code-block:: bash
47 .. code-block:: bash
48
48
49− $ sudo -i -u "${SERVICE_USER}"
49+ $ sudo -i -u \"${SERVICE_USER}\"
50 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/morty
50 (${SERVICE_USER}) $ go get -v -u github.com/asciimoo/morty
51
51
52.. END install morty
52.. END install morty
docs/build-templates/searx.rst+13−13
@@ -64,11 +64,11 @@ ${fedora_build}
64 .. code-block:: sh
64 .. code-block:: sh
65
65
66 $ sudo -H useradd --shell /bin/bash --system \\
66 $ sudo -H useradd --shell /bin/bash --system \\
67− --home-dir "$SERVICE_HOME" \\
67+ --home-dir \"$SERVICE_HOME\" \\
68 --comment 'Privacy-respecting metasearch engine' $SERVICE_USER
68 --comment 'Privacy-respecting metasearch engine' $SERVICE_USER
69
69
70− $ sudo -H mkdir "$SERVICE_HOME"
70+ $ sudo -H mkdir \"$SERVICE_HOME\"
71− $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
71+ $ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"
72
72
73.. END create user
73.. END create user
74
74
@@ -81,7 +81,7 @@ ${fedora_build}
81 .. code-block:: sh
81 .. code-block:: sh
82
82
83 $ sudo -H -u ${SERVICE_USER} -i
83 $ 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\"
85
85
86.. END clone searx
86.. END clone searx
87
87
@@ -93,8 +93,8 @@ ${fedora_build}
93
93
94 .. code-block:: sh
94 .. code-block:: sh
95
95
96− (${SERVICE_USER})$ python3 -m venv "${SEARX_PYENV}"
96+ (${SERVICE_USER})$ python3 -m venv \"${SEARX_PYENV}\"
97− (${SERVICE_USER})$ echo ". ${SEARX_PYENV}/bin/activate" >> "$SERVICE_HOME/.profile"
97+ (${SERVICE_USER})$ echo \". ${SEARX_PYENV}/bin/activate\" >> \"$SERVICE_HOME/.profile\"
98
98
99.. END create virtualenv
99.. END create virtualenv
100
100
@@ -118,7 +118,7 @@ ${fedora_build}
118 pip install -U wheel
118 pip install -U wheel
119
119
120 # jump to searx's working tree and install searx into virtualenv
120 # jump to searx's working tree and install searx into virtualenv
121− (${SERVICE_USER})$ cd "$SEARX_SRC"
121+ (${SERVICE_USER})$ cd \"$SEARX_SRC\"
122 (${SERVICE_USER})$ pip install -e .
122 (${SERVICE_USER})$ pip install -e .
123
123
124
124
@@ -132,9 +132,9 @@ ${fedora_build}
132
132
133 .. code-block:: sh
133 .. code-block:: sh
134
134
135− $ sudo -H cp "$SEARX_SRC/searx/settings.yml" "${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"
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"
137+ $ sudo -H sed -i -e \"s/{instance_name}/searx@\\$(uname -n)/g\" \"$SEARX_SETTINGS_PATH\"
138
138
139.. END searx config
139.. END searx config
140
140
@@ -147,16 +147,16 @@ ${fedora_build}
147 .. code-block:: sh
147 .. code-block:: sh
148
148
149 # enable debug ..
149 # 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\"
151
151
152 # start webapp
152 # start webapp
153 $ sudo -H -u ${SERVICE_USER} -i
153 $ sudo -H -u ${SERVICE_USER} -i
154 (${SERVICE_USER})$ cd ${SEARX_SRC}
154 (${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}\"
156 (${SERVICE_USER})$ python searx/webapp.py
156 (${SERVICE_USER})$ python searx/webapp.py
157
157
158 # disable debug
158 # 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\"
160
160
161Open WEB browser and visit http://$SEARX_INTERNAL_URL . If you are inside a
161Open WEB browser and visit http://$SEARX_INTERNAL_URL . If you are inside a
162container or in a script, test with curl:
162container or in a script, test with curl: