From 04c687403e21f883f9614e6a24df9ec450cfc111 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 11:49:33 +0100
Subject: [PATCH 01/25] [fix] brands: add variables from build env to jinja
 templating

We have some variables in the build environment which are also needed in the
templating process.  Theses variables are relavant if one creates a fork with
its own branding.  We treat these variables under the term 'brands'.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile                                     | 13 ++++++++++---
 searx/templates/__common__/about.html        | 12 ++++++------
 searx/templates/courgette/github_ribbon.html |  4 ++--
 searx/templates/legacy/github_ribbon.html    |  2 +-
 searx/templates/oscar/base.html              |  8 ++++----
 searx/templates/simple/base.html             |  6 +++---
 searx/webapp.py                              |  3 +++
 7 files changed, 29 insertions(+), 19 deletions(-)
 mode change 100644 => 100755 searx/webapp.py

diff --git a/Makefile b/Makefile
index 5a47129e4..3b2d499e8 100644
--- a/Makefile
+++ b/Makefile
@@ -71,15 +71,22 @@ $(GH_PAGES)::
 # update project files
 # --------------------
 
-PHONY += project engines-languages
+PHONY += project engines-languages searx.brand
 
-project: searx/data/engines_languages.json
+project: searx/data/engines_languages.json searx.brand
 
-searx/data/engines_languages.json:  pyenvinstall
+engines-languages:  pyenvinstall
 	$(PY_ENV_ACT); python utils/fetch_languages.py
 	mv engines_languages.json searx/data/engines_languages.json
 	mv languages.py searx/languages.py
 
+searx.brand:
+	$(Q)echo "build searx/brand.py"
+	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py
+	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
+	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
+	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
+
 # test
 # ----
 
diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html
index ff86ddd28..d8e1335d9 100644
--- a/searx/templates/__common__/about.html
+++ b/searx/templates/__common__/about.html
@@ -7,7 +7,7 @@
     <ul>
         <li>searx may not offer you as personalised results as Google, but it doesn't generate a profile about you</li>
         <li>searx doesn't care about what you search for, never shares anything with a third party, and it can't be used to compromise you</li>
-        <li>searx is free software, the code is 100% open and you can help to make it better. See more on <a href="https://github.com/asciimoo/searx">github</a></li>
+        <li>searx is free software, the code is 100% open and you can help to make it better. See more on <a href="{{ brand.GIT_URL }}">github</a></li>
     </ul>
     <p>If you do care about privacy, want to be a conscious user, or otherwise believe
     in digital freedom, make searx your default search engine or run it on your own server</p>
@@ -22,14 +22,14 @@ Searx can be added to your browser's search bar; moreover, it can be set as the
 
 <h2>How can I make it my own?</h2>
 
-<p>Searx appreciates your concern regarding logs, so take the <a href="https://github.com/asciimoo/searx">code</a> and run it yourself! <br />Add your Searx to this <a href="https://searx.space/">list</a> to help other people reclaim their privacy and make the Internet freer!
+<p>Searx appreciates your concern regarding logs, so take the <a href="{{ brand.GIT_URL }}">code</a> and run it yourself! <br />Add your Searx to this <a href="{{ brand.SEARX_URL }}">list</a> to help other people reclaim their privacy and make the Internet freer!
 <br />The more decentralized the Internet is, the more freedom we have!</p>
 
 
 <h2>More about searx</h2>
 
 <ul>
-    <li><a href="https://github.com/asciimoo/searx">github</a></li>
+    <li><a href="{{ brand.GIT_URL }}">github</a></li>
     <li><a href="https://www.ohloh.net/p/searx/">ohloh</a></li>
     <li><a href="https://twitter.com/Searx_engine">twitter</a></li>
     <li>IRC: #searx @ freenode (<a href="https://kiwiirc.com/client/irc.freenode.com/searx">webclient</a>)</li>
@@ -48,13 +48,13 @@ Searx can be added to your browser's search bar; moreover, it can be set as the
 
 <h3>New engines?</h3>
 <ul>
-    <li>Edit your <a href="https://raw.github.com/asciimoo/searx/master/searx/settings.yml">settings.yml</a></li>
-    <li>Create your custom engine module, check the <a href="https://github.com/asciimoo/searx/blob/master/examples/basic_engine.py">example engine</a></li>
+    <li>Edit your <a href="{{ brand.GIT_URL }}/blob/master/searx/settings.yml">settings.yml</a></li>
+    <li>Create your custom engine module, check the <a href="{{ brand.GIT_URL }}/blob/master/examples/basic_engine.py">example engine</a></li>
 </ul>
 <p>Don't forget to restart searx after config edit!</p>
 
 <h3>Installation/WSGI support?</h3>
-<p>See the <a href="https://github.com/asciimoo/searx/wiki/Installation">installation and setup</a> wiki page</p>
+<p>See the <a href="{{ brand.DOCS_URL }}/admin/installation.html#uwsgi">installation and uwsgi setup</a></p>
 
 <h3>How to debug engines?</h3>
 <p><a href="{{ url_for('stats') }}">Stats page</a> contains some useful data about the engines used.</p>
diff --git a/searx/templates/courgette/github_ribbon.html b/searx/templates/courgette/github_ribbon.html
index 67c6e678f..f6eaa123c 100644
--- a/searx/templates/courgette/github_ribbon.html
+++ b/searx/templates/courgette/github_ribbon.html
@@ -1,3 +1,3 @@
-<a href="https://github.com/asciimoo/searx" class="github">
+<a href="{{ brand.GIT_URL }}" class="github">
     <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ url_for('static', filename='img/github_ribbon.png') }}" alt="Fork me on GitHub"  class="github"/>
-</a>
\ No newline at end of file
+</a>
diff --git a/searx/templates/legacy/github_ribbon.html b/searx/templates/legacy/github_ribbon.html
index bdd9cf180..f6eaa123c 100644
--- a/searx/templates/legacy/github_ribbon.html
+++ b/searx/templates/legacy/github_ribbon.html
@@ -1,3 +1,3 @@
-<a href="https://github.com/asciimoo/searx" class="github">
+<a href="{{ brand.GIT_URL }}" class="github">
     <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ url_for('static', filename='img/github_ribbon.png') }}" alt="Fork me on GitHub"  class="github"/>
 </a>
diff --git a/searx/templates/oscar/base.html b/searx/templates/oscar/base.html
index 9465ca58a..4fe335798 100644
--- a/searx/templates/oscar/base.html
+++ b/searx/templates/oscar/base.html
@@ -85,10 +85,10 @@
             {% endblock %}
             <p class="text-muted">
                 <small>
-                    {{ _('Powered by') }} <a href="https://asciimoo.github.io/searx/">searx</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
-                    <a href="https://github.com/asciimoo/searx">{{ _('Source code') }}</a> |
-                    <a href="https://github.com/asciimoo/searx/issues">{{ _('Issue tracker') }}</a> |
-                    <a href="https://searx.space/">{{ _('Public instances') }}</a>
+                    {{ _('Powered by') }} <a href="{{ brand.DOCS_URL }}">searx</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
+                    <a href="{{ brand.GIT_URL }}">{{ _('Source code') }}</a> |
+                    <a href="{{ brand.GIT_URL }}/issues">{{ _('Issue tracker') }}</a> |
+                    <a href="{{ brand.PUBLIC_INSTANCES }}">{{ _('Public instances') }}</a>
                 </small>
             </p>
         </div>
diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html
index bba02dbf8..b5b184071 100644
--- a/searx/templates/simple/base.html
+++ b/searx/templates/simple/base.html
@@ -51,9 +51,9 @@
   <footer>
     <p>
     {{ _('Powered by') }} <a href="{{ url_for('about') }}">searx</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
-        <a href="https://github.com/asciimoo/searx">{{ _('Source code') }}</a> |
-        <a href="https://github.com/asciimoo/searx/issues">{{ _('Issue tracker') }}</a> |
-        <a href="https://searx.space/">{{ _('Public instances') }}</a>
+        <a href="{{ brand.GIT_URL }}">{{ _('Source code') }}</a> |
+        <a href="{{ brand.GIT_URL }}/issues">{{ _('Issue tracker') }}</a> |
+        <a href="{{ brand.PUBLIC_INSTANCES }}">{{ _('Public instances') }}</a>
     </p>
   </footer>
   <!--[if gte IE 9]>-->
diff --git a/searx/webapp.py b/searx/webapp.py
old mode 100644
new mode 100755
index b3928921e..c6b52d6ab
--- a/searx/webapp.py
+++ b/searx/webapp.py
@@ -57,6 +57,7 @@ from babel.support import Translations
 import flask_babel
 from flask_babel import Babel, gettext, format_date, format_decimal
 from flask.json import jsonify
+from searx import brand
 from searx import settings, searx_dir, searx_debug
 from searx.exceptions import SearxParameterException
 from searx.engines import (
@@ -427,6 +428,8 @@ def render(template_name, override_theme=None, **kwargs):
 
     kwargs['preferences'] = request.preferences
 
+    kwargs['brand'] = brand
+
     kwargs['scripts'] = set()
     for plugin in request.user_plugins:
         for script in plugin.js_dependencies:

From e84fc94300750c41642bea97d2d9cc020f746c66 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 11:51:03 +0100
Subject: [PATCH 02/25] [fix] brands: add variables from build env to
 sphinx-doc

We have some variables in the build environment which are also needed in the
sphinx-process.  Theses variables are relavant if one creates a fork with
its own branding.  We treat these variables under the term 'brands'.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/conf.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index ebcd102b2..03e977aba 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -4,9 +4,9 @@ import  sys, os
 from searx.version import VERSION_STRING
 from pallets_sphinx_themes import ProjectLink
 
-GIT_URL = os.environ.get("GIT_URL", "https://github.com/asciimoo/searx")
-SEARX_URL = os.environ.get("SEARX_URL", "https://searx.me")
-DOCS_URL = os.environ.get("DOCS_URL", "https://asciimoo.github.io/searx/")
+from searx.brand import GIT_URL
+from searx.brand import SEARX_URL
+from searx.brand import DOCS_URL
 
 # Project --------------------------------------------------------------
 

From f6b29f68a107ac083bd5df0d6e7bda8a05f4479f Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 12:03:11 +0100
Subject: [PATCH 03/25] [fix] brands: add variables from build env to setup.py

We have some variables in the build environment which are also needed in the
setup.py process.  Theses variables are relavant if one creates a fork with
its own branding.  We treat these variables under the term 'brands'.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 setup.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index bd3dd5d1c..bd00211b2 100644
--- a/setup.py
+++ b/setup.py
@@ -10,6 +10,7 @@ import sys
 # required to load VERSION_STRING constant
 sys.path.insert(0, './searx')
 from version import VERSION_STRING
+import brand
 
 with open('README.rst') as f:
     long_description = f.read()
@@ -36,7 +37,7 @@ setup(
     keywords='metasearch searchengine search web http',
     author='Adam Tauber',
     author_email='asciimoo@gmail.com',
-    url='https://github.com/asciimoo/searx',
+    url=brand.GIT_URL,
     license='GNU Affero General Public License',
     packages=find_packages(exclude=["tests*"]),
     zip_safe=False,

From aaf22baad2d0b361e01b8eb2c10de5d03875ecb6 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 12:14:21 +0100
Subject: [PATCH 04/25] make project: re-build generic files of the searx
 project

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/brand.py | 4 ++++
 1 file changed, 4 insertions(+)
 create mode 100644 searx/brand.py

diff --git a/searx/brand.py b/searx/brand.py
new file mode 100644
index 000000000..7cbca7b0f
--- /dev/null
+++ b/searx/brand.py
@@ -0,0 +1,4 @@
+GIT_URL = 'https://github.com/asciimoo/searx'
+SEARX_URL = 'https://searx.me'
+DOCS_URL = 'https://asciimoo.github.io/searx'
+PUBLIC_INSTANCES = 'https://searx.space'

From 757ebb5d9fdc24757f199e52575f32f6faf091b3 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 14:09:47 +0100
Subject: [PATCH 05/25] [fix] brands: add variables from build env to grunt
 process

We have some variables in the build environment which are also needed in the
grunt process when building themes.  Theses variables are relavant if one
creates a fork with its own branding.  We treat these variables under the term
'brands'.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile                                | 15 +++++++++++++++
 docs/dev/quickstart.rst                 |  6 +++---
 manage.sh                               | 10 ----------
 searx/static/themes/oscar/gruntfile.js  |  4 +---
 searx/static/themes/simple/gruntfile.js |  6 +++---
 5 files changed, 22 insertions(+), 19 deletions(-)

diff --git a/Makefile b/Makefile
index 3b2d499e8..4914a309e 100644
--- a/Makefile
+++ b/Makefile
@@ -28,6 +28,7 @@ help:
 	@echo  '  gh-pages  - build docs & deploy on gh-pages branch'
 	@echo  '  clean     - drop builds and environments'
 	@echo  '  project   - re-build generic files of the searx project'
+	@echo  '  themes    - re-build build the source of the themes'
 	@echo  ''
 	@$(MAKE) -s -f utils/makefile.include make-help
 	@echo  ''
@@ -87,6 +88,20 @@ searx.brand:
 	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
 	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
 
+# build themes
+# ------------
+
+PHONY += themes themes.oscar themes.simple
+themes: themes.oscar themes.simple
+
+themes.oscar:
+	$(Q)echo '[!] Grunt build : oscar theme'
+	$(Q)grunt --gruntfile  "searx/static/themes/oscar/gruntfile.js"
+
+themes.simple:
+	$(Q)echo '[!] Grunt build : simple theme'
+	$(Q)grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
+
 # test
 # ----
 
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index e40772b3b..cb079a753 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -87,8 +87,8 @@ After satisfying the requirements styles can be build using ``manage.sh``
    ./manage.sh styles
 
 
-How to build the source of the oscar theme
-==========================================
+How to build the source of the themes
+=====================================
 
 .. _grunt: https://gruntjs.com/
 
@@ -104,7 +104,7 @@ After installing grunt, the files can be built using the following command:
 
 .. code:: sh
 
-   ./manage.sh grunt_build
+   make themes
 
 
 Tips for debugging/development
diff --git a/manage.sh b/manage.sh
index 496a522ba..0551f02d3 100755
--- a/manage.sh
+++ b/manage.sh
@@ -156,15 +156,6 @@ styles() {
     build_style less/bootstrap/bootstrap.less css/bootstrap.min.css
 }
 
-grunt_build() {
-    npm_path_setup
-
-    echo '[!] Grunt build : oscar theme'
-    grunt --gruntfile "$SEARX_DIR/static/themes/oscar/gruntfile.js"
-    echo '[!] Grunt build : simple theme'
-    grunt --gruntfile "$SEARX_DIR/static/themes/simple/gruntfile.js"
-}
-
 docker_build() {
     # Check if it is a git repository
     if [ ! -d .git ]; then
@@ -257,7 +248,6 @@ Commands
     -----
     locales              - Compile locales
     styles               - Build less files
-    grunt_build          - Build files for themes
     docker_build         - Build Docker image
 
     Tests
diff --git a/searx/static/themes/oscar/gruntfile.js b/searx/static/themes/oscar/gruntfile.js
index def035dba..606b6bcfb 100644
--- a/searx/static/themes/oscar/gruntfile.js
+++ b/searx/static/themes/oscar/gruntfile.js
@@ -13,7 +13,7 @@ module.exports = function(grunt) {
     },
     uglify: {
       options: {
-        banner: '/*! oscar/searx.min.js | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n'
+        banner: '/*! oscar/searx.min.js | <%= grunt.template.today("dd-mm-yyyy") %> | <%= process.env.GIT_URL %>  */\n'
       },
       dist: {
         files: {
@@ -38,7 +38,6 @@ module.exports = function(grunt) {
         development: {
             options: {
                 paths: ["less/pointhi", "less/logicodev", "less/logicodev-dark"]
-                //banner: '/*! less/oscar/oscar.css | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n'
             },
             files: {"css/pointhi.css": "less/pointhi/oscar.less",
                     "css/logicodev.css": "less/logicodev-dark/oscar.less",
@@ -47,7 +46,6 @@ module.exports = function(grunt) {
         production: {
             options: {
                 paths: ["less/pointhi", "less/logicodev", "less/logicodev-dark"],
-                //banner: '/*! less/oscar/oscar.css | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n',
                 cleancss: true
             },
             files: {"css/pointhi.min.css": "less/pointhi/oscar.less",
diff --git a/searx/static/themes/simple/gruntfile.js b/searx/static/themes/simple/gruntfile.js
index c372ec730..c8f2ed3c6 100644
--- a/searx/static/themes/simple/gruntfile.js
+++ b/searx/static/themes/simple/gruntfile.js
@@ -36,7 +36,7 @@ module.exports = function(grunt) {
     },
     uglify: {
       options: {
-        banner: '/*! simple/searx.min.js | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n',
+        banner: '/*! simple/searx.min.js | <%= grunt.template.today("dd-mm-yyyy") %> | <%= process.env.GIT_URL %> */\n',
         output: {
 	        comments: 'some'
         },
@@ -57,7 +57,7 @@ module.exports = function(grunt) {
       development: {
         options: {
           paths: ["less"],
-          banner: '/*! searx | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n'
+          banner: '/*! searx | <%= grunt.template.today("dd-mm-yyyy") %> | <%= process.env.GIT_URL %> */\n'
         },
         files: {
           "css/searx.css": "less/style.less",
@@ -73,7 +73,7 @@ module.exports = function(grunt) {
               compatibility: '*'
             })
           ],
-          banner: '/*! searx | <%= grunt.template.today("dd-mm-yyyy") %> | https://github.com/asciimoo/searx */\n'
+          banner: '/*! searx | <%= grunt.template.today("dd-mm-yyyy") %> | <%= process.env.GIT_URL %> */\n'
         },
         files: {
           "css/searx.min.css": "less/style.less",

From 3dbade0aed048e6001f2ed0f261c7d26f04768ba Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 14:50:39 +0100
Subject: [PATCH 06/25] [fix] brands: add GIT_URL variable to the docker build

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Dockerfile | 3 ++-
 Makefile   | 9 +++++++++
 manage.sh  | 5 ++---
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 9885fb794..700a21ffc 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -4,6 +4,7 @@ EXPOSE 8080
 VOLUME /etc/searx
 VOLUME /var/log/uwsgi
 
+ARG GIT_URL=unknown
 ARG VERSION_GITCOMMIT=unknown
 ARG SEARX_GIT_VERSION=unknown
 
@@ -66,7 +67,7 @@ RUN su searx -c "/usr/bin/python3 -m compileall -q searx"; \
 
 # Keep this argument at the end since it change each time
 ARG LABEL_DATE=
-LABEL maintainer="searx <https://github.com/asciimoo/searx>" \
+LABEL maintainer="searx <${GIT_URL}>" \
       description="A privacy-respecting, hackable metasearch engine." \
       version="${SEARX_GIT_VERSION}" \
       org.label-schema.schema-version="1.0" \
diff --git a/Makefile b/Makefile
index 4914a309e..f81b4e1de 100644
--- a/Makefile
+++ b/Makefile
@@ -29,6 +29,7 @@ help:
 	@echo  '  clean     - drop builds and environments'
 	@echo  '  project   - re-build generic files of the searx project'
 	@echo  '  themes    - re-build build the source of the themes'
+	@echo  '  docker    - build Docker image'
 	@echo  ''
 	@$(MAKE) -s -f utils/makefile.include make-help
 	@echo  ''
@@ -102,6 +103,14 @@ themes.simple:
 	$(Q)echo '[!] Grunt build : simple theme'
 	$(Q)grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
 
+# docker
+# ------
+
+PHONY += docker
+docker:
+	$(Q)./manage.sh docker_build
+
+
 # test
 # ----
 
diff --git a/manage.sh b/manage.sh
index 0551f02d3..bb3fe8831 100755
--- a/manage.sh
+++ b/manage.sh
@@ -202,13 +202,13 @@ docker_build() {
     fi
 
     # define the docker image name
-    # /!\ HACK to get the user name /!\
-    GITHUB_USER=$(git remote get-url origin | sed 's/.*github\.com\/\([^\/]*\).*/\1/')
+    GITHUB_USER=$(echo "${GIT_URL}" | sed 's/.*github\.com\/\([^\/]*\).*/\1/')
     SEARX_IMAGE_NAME="${GITHUB_USER:-searx}/searx"
 
     # build Docker image
     echo "Building image ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION}"
     sudo docker build \
+         --build-arg GIT_URL="${GIT_URL}" \
          --build-arg SEARX_GIT_VERSION="${SEARX_GIT_VERSION}" \
          --build-arg VERSION_GITCOMMIT="${VERSION_GITCOMMIT}" \
          --build-arg LABEL_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
@@ -248,7 +248,6 @@ Commands
     -----
     locales              - Compile locales
     styles               - Build less files
-    docker_build         - Build Docker image
 
     Tests
     -----

From 2d12f221a7afbbbaedfb27c5705efd8b94ad6a81 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 15:17:11 +0100
Subject: [PATCH 07/25] [fix] docker build: set build argument LABEL_VCS_URL to
 GIT_URL

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 manage.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/manage.sh b/manage.sh
index bb3fe8831..4c11576a3 100755
--- a/manage.sh
+++ b/manage.sh
@@ -213,7 +213,7 @@ docker_build() {
          --build-arg VERSION_GITCOMMIT="${VERSION_GITCOMMIT}" \
          --build-arg LABEL_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
          --build-arg LABEL_VCS_REF=$(git rev-parse HEAD) \
-         --build-arg LABEL_VCS_URL=$(git remote get-url origin) \
+         --build-arg LABEL_VCS_URL="${GIT_URL}" \
 	 --build-arg TIMESTAMP_SETTINGS=$(git log -1 --format="%cd" --date=unix -- searx/settings.yml) \
 	 --build-arg TIMESTAMP_UWSGI=$(git log -1 --format="%cd" --date=unix -- dockerfiles/uwsgi.ini) \
          -t ${SEARX_IMAGE_NAME}:latest -t ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION} .

From d471ec86dd72cfae80bdaf72b1ed266b1a8cada7 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 16:38:52 +0100
Subject: [PATCH 08/25] Makefile: add target node.env  - download & install npm
 dependencies

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 .gitignore                            |  3 ++-
 Makefile                              | 23 ++++++++++++++++++++---
 docs/dev/quickstart.rst               |  2 +-
 searx/static/themes/oscar/.gitignore  |  3 ++-
 searx/static/themes/simple/.gitignore |  2 ++
 5 files changed, 27 insertions(+), 6 deletions(-)
 create mode 100644 searx/static/themes/simple/.gitignore

diff --git a/.gitignore b/.gitignore
index 069dfd35b..9e08e2a47 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,7 +15,8 @@ setup.cfg
 */*.pyc
 *~
 
-node_modules/
+/node_modules
+/package-lock.json
 
 .tx/
 
diff --git a/Makefile b/Makefile
index f81b4e1de..5796ae668 100644
--- a/Makefile
+++ b/Makefile
@@ -30,6 +30,7 @@ help:
 	@echo  '  project   - re-build generic files of the searx project'
 	@echo  '  themes    - re-build build the source of the themes'
 	@echo  '  docker    - build Docker image'
+	@echo  '  node.env  - download & install npm dependencies locally'
 	@echo  ''
 	@$(MAKE) -s -f utils/makefile.include make-help
 	@echo  ''
@@ -42,7 +43,7 @@ PHONY += uninstall
 uninstall: pyenvuninstall
 
 PHONY += clean
-clean: pyclean
+clean: pyclean node.clean
 	$(call cmd,common_clean)
 
 PHONY += run
@@ -89,6 +90,22 @@ searx.brand:
 	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
 	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
 
+# node / npm
+# ----------
+
+node.env:
+	$(Q)./manage.sh npm_packages
+
+node.clean:
+	$(Q)echo "CLEAN     locally installed npm dependencies"
+	$(Q)rm -rf \
+	  ./node_modules  \
+	  ./package-lock.json \
+	  ./searx/static/themes/oscar/package-lock.json \
+	  ./searx/static/themes/oscar/node_modules \
+	  ./searx/static/themes/simple/package-lock.json \
+	  ./searx/static/themes/simple/node_modules
+
 # build themes
 # ------------
 
@@ -97,11 +114,11 @@ themes: themes.oscar themes.simple
 
 themes.oscar:
 	$(Q)echo '[!] Grunt build : oscar theme'
-	$(Q)grunt --gruntfile  "searx/static/themes/oscar/gruntfile.js"
+	$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile  "searx/static/themes/oscar/gruntfile.js"
 
 themes.simple:
 	$(Q)echo '[!] Grunt build : simple theme'
-	$(Q)grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
+	$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
 
 # docker
 # ------
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index cb079a753..a786eda63 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -98,7 +98,7 @@ NodeJS, so first Node has to be installed.
 .. code:: sh
 
    sudo -H apt-get install nodejs
-   sudo -H npm install -g grunt-cli
+   make node.env
 
 After installing grunt, the files can be built using the following command:
 
diff --git a/searx/static/themes/oscar/.gitignore b/searx/static/themes/oscar/.gitignore
index c2658d7d1..49e0fc6b4 100644
--- a/searx/static/themes/oscar/.gitignore
+++ b/searx/static/themes/oscar/.gitignore
@@ -1 +1,2 @@
-node_modules/
+/node_modules
+/package-lock.json
\ No newline at end of file
diff --git a/searx/static/themes/simple/.gitignore b/searx/static/themes/simple/.gitignore
new file mode 100644
index 000000000..49e0fc6b4
--- /dev/null
+++ b/searx/static/themes/simple/.gitignore
@@ -0,0 +1,2 @@
+/node_modules
+/package-lock.json
\ No newline at end of file

From ace7d30aed0bdff07e97cdb3900c38633877cdcd Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 17:12:02 +0100
Subject: [PATCH 09/25] webapp.py: partial code review (no functional change)

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/webapp.py | 69 +++++++++++++++++++++++++++++--------------------
 1 file changed, 41 insertions(+), 28 deletions(-)

diff --git a/searx/webapp.py b/searx/webapp.py
index c6b52d6ab..3af5c57b4 100755
--- a/searx/webapp.py
+++ b/searx/webapp.py
@@ -958,34 +958,47 @@ def clear_cookies():
 
 @app.route('/config')
 def config():
-    return jsonify({'categories': list(categories.keys()),
-                    'engines': [{'name': name,
-                                 'categories': engine.categories,
-                                 'shortcut': engine.shortcut,
-                                 'enabled': not engine.disabled,
-                                 'paging': engine.paging,
-                                 'language_support': engine.language_support,
-                                 'supported_languages':
-                                 list(engine.supported_languages.keys())
-                                 if isinstance(engine.supported_languages, dict)
-                                 else engine.supported_languages,
-                                 'safesearch': engine.safesearch,
-                                 'time_range_support': engine.time_range_support,
-                                 'timeout': engine.timeout}
-                                for name, engine in engines.items() if request.preferences.validate_token(engine)],
-                    'plugins': [{'name': plugin.name,
-                                 'enabled': plugin.default_on}
-                                for plugin in plugins],
-                    'instance_name': settings['general']['instance_name'],
-                    'locales': settings['locales'],
-                    'default_locale': settings['ui']['default_locale'],
-                    'autocomplete': settings['search']['autocomplete'],
-                    'safe_search': settings['search']['safe_search'],
-                    'default_theme': settings['ui']['default_theme'],
-                    'version': VERSION_STRING,
-                    'doi_resolvers': [r for r in settings['doi_resolvers']],
-                    'default_doi_resolver': settings['default_doi_resolver'],
-                    })
+    """Return configuration in JSON format."""
+    _engines = []
+    for name, engine in engines.items():
+        if not request.preferences.validate_token(engine):
+            continue
+
+        supported_languages = engine.supported_languages
+        if isinstance(engine.supported_languages, dict):
+            supported_languages = list(engine.supported_languages.keys())
+
+        _engines.append({
+            'name': name,
+            'categories': engine.categories,
+            'shortcut': engine.shortcut,
+            'enabled': not engine.disabled,
+            'paging': engine.paging,
+            'language_support': engine.language_support,
+            'supported_languages': supported_languages,
+            'safesearch': engine.safesearch,
+            'time_range_support': engine.time_range_support,
+            'timeout': engine.timeout
+        })
+
+    _plugins = []
+    for _ in plugins:
+        _plugins.append({'name': _.name, 'enabled': _.default_on})
+
+    return jsonify({
+        'categories': list(categories.keys()),
+        'engines': _engines,
+        'plugins': _plugins,
+        'instance_name': settings['general']['instance_name'],
+        'locales': settings['locales'],
+        'default_locale': settings['ui']['default_locale'],
+        'autocomplete': settings['search']['autocomplete'],
+        'safe_search': settings['search']['safe_search'],
+        'default_theme': settings['ui']['default_theme'],
+        'version': VERSION_STRING,
+        'doi_resolvers': [r for r in settings['doi_resolvers']],
+        'default_doi_resolver': settings['default_doi_resolver'],
+    })
 
 
 @app.errorhandler(404)

From 4d6482823764c840415a6023d945b5699a53ba2a Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 17:28:32 +0100
Subject: [PATCH 10/25] webapp.py: expose the brand variable in the /config
 URL.

E.g. helpful for searx-stats2

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/webapp.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/searx/webapp.py b/searx/webapp.py
index 3af5c57b4..c910230ab 100755
--- a/searx/webapp.py
+++ b/searx/webapp.py
@@ -996,6 +996,10 @@ def config():
         'safe_search': settings['search']['safe_search'],
         'default_theme': settings['ui']['default_theme'],
         'version': VERSION_STRING,
+        'brand': {
+            'GIT_URL': brand.GIT_URL,
+            'DOCS_URL': brand.DOCS_URL
+        },
         'doi_resolvers': [r for r in settings['doi_resolvers']],
         'default_doi_resolver': settings['default_doi_resolver'],
     })

From 33814719333c2c5b7b13ab47f9c8d4f8a0cecb16 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 25 Mar 2020 17:48:34 +0100
Subject: [PATCH 11/25] brands: add ISSUE_URL

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile                         | 2 ++
 searx/brand.py                   | 1 +
 searx/templates/oscar/base.html  | 2 +-
 searx/templates/simple/base.html | 2 +-
 setup.py                         | 6 +++++-
 5 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 5796ae668..bdaa6c774 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
 # -*- coding: utf-8; mode: makefile-gmake -*-
 
 export GIT_URL=https://github.com/asciimoo/searx
+export ISSUE_URL=$(GIT_URL)/issues
 export SEARX_URL=https://searx.me
 export DOCS_URL=https://asciimoo.github.io/searx
 
@@ -86,6 +87,7 @@ engines-languages:  pyenvinstall
 searx.brand:
 	$(Q)echo "build searx/brand.py"
 	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py
+	$(Q)echo "ISSUE_URL = '$(ISSUE_URL)'" >> searx/brand.py
 	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
 	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
 	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
diff --git a/searx/brand.py b/searx/brand.py
index 7cbca7b0f..d563447f6 100644
--- a/searx/brand.py
+++ b/searx/brand.py
@@ -1,4 +1,5 @@
 GIT_URL = 'https://github.com/asciimoo/searx'
+ISSUE_URL = 'https://github.com/asciimoo/searx/issues'
 SEARX_URL = 'https://searx.me'
 DOCS_URL = 'https://asciimoo.github.io/searx'
 PUBLIC_INSTANCES = 'https://searx.space'
diff --git a/searx/templates/oscar/base.html b/searx/templates/oscar/base.html
index 4fe335798..5eb4462e4 100644
--- a/searx/templates/oscar/base.html
+++ b/searx/templates/oscar/base.html
@@ -87,7 +87,7 @@
                 <small>
                     {{ _('Powered by') }} <a href="{{ brand.DOCS_URL }}">searx</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
                     <a href="{{ brand.GIT_URL }}">{{ _('Source code') }}</a> |
-                    <a href="{{ brand.GIT_URL }}/issues">{{ _('Issue tracker') }}</a> |
+                    <a href="{{ brand.ISSUE_URL }}">{{ _('Issue tracker') }}</a> |
                     <a href="{{ brand.PUBLIC_INSTANCES }}">{{ _('Public instances') }}</a>
                 </small>
             </p>
diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html
index b5b184071..71df123ea 100644
--- a/searx/templates/simple/base.html
+++ b/searx/templates/simple/base.html
@@ -52,7 +52,7 @@
     <p>
     {{ _('Powered by') }} <a href="{{ url_for('about') }}">searx</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
         <a href="{{ brand.GIT_URL }}">{{ _('Source code') }}</a> |
-        <a href="{{ brand.GIT_URL }}/issues">{{ _('Issue tracker') }}</a> |
+        <a href="{{ brand.ISSUE_URL }}">{{ _('Issue tracker') }}</a> |
         <a href="{{ brand.PUBLIC_INSTANCES }}">{{ _('Public instances') }}</a>
     </p>
   </footer>
diff --git a/setup.py b/setup.py
index bd00211b2..97a3270ef 100644
--- a/setup.py
+++ b/setup.py
@@ -26,6 +26,11 @@ setup(
     version=VERSION_STRING,
     description="A privacy-respecting, hackable metasearch engine",
     long_description=long_description,
+    url=brand.DOCS_URL,
+    project_urls={
+        "Code": brand.GIT_URL,
+        "Issue tracker": brand.ISSUE_URL
+    },
     classifiers=[
         "Development Status :: 4 - Beta",
         "Programming Language :: Python",
@@ -37,7 +42,6 @@ setup(
     keywords='metasearch searchengine search web http',
     author='Adam Tauber',
     author_email='asciimoo@gmail.com',
-    url=brand.GIT_URL,
     license='GNU Affero General Public License',
     packages=find_packages(exclude=["tests*"]),
     zip_safe=False,

From 3486613a1960f472b9cf8c85ade72c5aec9473eb Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 10:58:25 +0100
Subject: [PATCH 12/25] brands: hardcode ISSUE_URL and some links on the
 about-page

A *brand* of searx is a fork which might have its own design and some special
functions which might bee reasonable in a special context.

In this sense, the fork might have its own documentation but not its own issue
tracker.  The *upstream* of a brand is always https://github.com/asciimoo from
where the brand-fork pulls the master branch regularly.  A fork which has its
own issue tracker is a spin-off and out of the scope of the searx project
itself.  The conclusion is:

- hard code ISSUE_URL (in the Makefile)
- always refer to DOCS_URL
- links in the about page refer to the *upstream* (searx project)
  except DOCS_URL
- "fork me on github" ribbons refer to the *upstream*

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile                                     |  3 +--
 searx/templates/__common__/about.html        | 11 +++++------
 searx/templates/courgette/github_ribbon.html |  2 +-
 searx/templates/legacy/github_ribbon.html    |  2 +-
 4 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/Makefile b/Makefile
index bdaa6c774..2bea06c9d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,6 @@
 # -*- coding: utf-8; mode: makefile-gmake -*-
 
 export GIT_URL=https://github.com/asciimoo/searx
-export ISSUE_URL=$(GIT_URL)/issues
 export SEARX_URL=https://searx.me
 export DOCS_URL=https://asciimoo.github.io/searx
 
@@ -87,7 +86,7 @@ engines-languages:  pyenvinstall
 searx.brand:
 	$(Q)echo "build searx/brand.py"
 	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py
-	$(Q)echo "ISSUE_URL = '$(ISSUE_URL)'" >> searx/brand.py
+	$(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py
 	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
 	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
 	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html
index d8e1335d9..3f702e63f 100644
--- a/searx/templates/__common__/about.html
+++ b/searx/templates/__common__/about.html
@@ -7,7 +7,7 @@
     <ul>
         <li>searx may not offer you as personalised results as Google, but it doesn't generate a profile about you</li>
         <li>searx doesn't care about what you search for, never shares anything with a third party, and it can't be used to compromise you</li>
-        <li>searx is free software, the code is 100% open and you can help to make it better. See more on <a href="{{ brand.GIT_URL }}">github</a></li>
+        <li>searx is free software, the code is 100% open and you can help to make it better. See more on <a href="https://github.com/asciimoo/searx">github</a></li>
     </ul>
     <p>If you do care about privacy, want to be a conscious user, or otherwise believe
     in digital freedom, make searx your default search engine or run it on your own server</p>
@@ -22,15 +22,14 @@ Searx can be added to your browser's search bar; moreover, it can be set as the
 
 <h2>How can I make it my own?</h2>
 
-<p>Searx appreciates your concern regarding logs, so take the <a href="{{ brand.GIT_URL }}">code</a> and run it yourself! <br />Add your Searx to this <a href="{{ brand.SEARX_URL }}">list</a> to help other people reclaim their privacy and make the Internet freer!
+<p>Searx appreciates your concern regarding logs, so take the <a href="https://github.com/asciimoo/searx">code</a> and run it yourself! <br />Add your Searx to this <a href="{{ brand.PUBLIC_INSTANCES }}">list</a> to help other people reclaim their privacy and make the Internet freer!
 <br />The more decentralized the Internet is, the more freedom we have!</p>
 
 
 <h2>More about searx</h2>
 
 <ul>
-    <li><a href="{{ brand.GIT_URL }}">github</a></li>
-    <li><a href="https://www.ohloh.net/p/searx/">ohloh</a></li>
+    <li><a href="https://github.com/asciimoo/searx">github</a></li>
     <li><a href="https://twitter.com/Searx_engine">twitter</a></li>
     <li>IRC: #searx @ freenode (<a href="https://kiwiirc.com/client/irc.freenode.com/searx">webclient</a>)</li>
     <li><a href="https://www.transifex.com/projects/p/searx/">transifex</a></li>
@@ -48,8 +47,8 @@ Searx can be added to your browser's search bar; moreover, it can be set as the
 
 <h3>New engines?</h3>
 <ul>
-    <li>Edit your <a href="{{ brand.GIT_URL }}/blob/master/searx/settings.yml">settings.yml</a></li>
-    <li>Create your custom engine module, check the <a href="{{ brand.GIT_URL }}/blob/master/examples/basic_engine.py">example engine</a></li>
+    <li>Edit your <a href="https://github.com/asciimoo/searx/blob/master/searx/settings.yml">settings.yml</a></li>
+    <li>Create your custom engine module, check the <a href="https://github.com/asciimoo/searx/blob/master/examples/basic_engine.py">example engine</a></li>
 </ul>
 <p>Don't forget to restart searx after config edit!</p>
 
diff --git a/searx/templates/courgette/github_ribbon.html b/searx/templates/courgette/github_ribbon.html
index f6eaa123c..bdd9cf180 100644
--- a/searx/templates/courgette/github_ribbon.html
+++ b/searx/templates/courgette/github_ribbon.html
@@ -1,3 +1,3 @@
-<a href="{{ brand.GIT_URL }}" class="github">
+<a href="https://github.com/asciimoo/searx" class="github">
     <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ url_for('static', filename='img/github_ribbon.png') }}" alt="Fork me on GitHub"  class="github"/>
 </a>
diff --git a/searx/templates/legacy/github_ribbon.html b/searx/templates/legacy/github_ribbon.html
index f6eaa123c..bdd9cf180 100644
--- a/searx/templates/legacy/github_ribbon.html
+++ b/searx/templates/legacy/github_ribbon.html
@@ -1,3 +1,3 @@
-<a href="{{ brand.GIT_URL }}" class="github">
+<a href="https://github.com/asciimoo/searx" class="github">
     <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ url_for('static', filename='img/github_ribbon.png') }}" alt="Fork me on GitHub"  class="github"/>
 </a>

From 5d087ee466750e51dfc9ff95a88402055ad71741 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 13:09:29 +0100
Subject: [PATCH 13/25] Rewrite of the HTL *about* page

The *about* page should only address higher-level issues that are important to
each user.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/templates/__common__/about.html | 120 +++++++++++++++++---------
 1 file changed, 77 insertions(+), 43 deletions(-)

diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html
index 3f702e63f..c912a8bd2 100644
--- a/searx/templates/__common__/about.html
+++ b/searx/templates/__common__/about.html
@@ -1,62 +1,96 @@
 <div{% if rtl %} dir="ltr"{% endif %}>
-    <h1>About <a href="{{ url_for('index') }}">searx</a></h1>
+  <h1>About <a href="{{ url_for('index') }}">searx</a></h1>
 
-    <p>Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>, aggregating the results of other <a href="{{ url_for('preferences') }}">search engines</a> while not storing information about its users.
-    </p>
-    <h2>Why use searx?</h2>
-    <ul>
-        <li>searx may not offer you as personalised results as Google, but it doesn't generate a profile about you</li>
-        <li>searx doesn't care about what you search for, never shares anything with a third party, and it can't be used to compromise you</li>
-        <li>searx is free software, the code is 100% open and you can help to make it better. See more on <a href="https://github.com/asciimoo/searx">github</a></li>
-    </ul>
-    <p>If you do care about privacy, want to be a conscious user, or otherwise believe
-    in digital freedom, make searx your default search engine or run it on your own server</p>
+  <p>
+    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    aggregating the results of other <a href="{{ url_for('preferences') }}">search engines</a>
+    while not storing information about its users.
+  </p>
 
-<h2>Technical details - How does it work?</h2>
+  <p>More about searx ...</p>
 
-<p>Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
-inspired by the <a href="https://beniz.github.io/seeks/">seeks project</a>.<br />
-It provides basic privacy by mixing your queries with searches on other platforms without storing search data. Queries are made using a POST request on every browser (except chrome*). Therefore they show up in neither our logs, nor your url history. In case of Chrome* users there is an exception, searx uses the search bar to perform GET requests.<br />
-Searx can be added to your browser's search bar; moreover, it can be set as the default search engine.
-</p>
-
-<h2>How can I make it my own?</h2>
-
-<p>Searx appreciates your concern regarding logs, so take the <a href="https://github.com/asciimoo/searx">code</a> and run it yourself! <br />Add your Searx to this <a href="{{ brand.PUBLIC_INSTANCES }}">list</a> to help other people reclaim their privacy and make the Internet freer!
-<br />The more decentralized the Internet is, the more freedom we have!</p>
-
-
-<h2>More about searx</h2>
-
-<ul>
+  <ul>
     <li><a href="https://github.com/asciimoo/searx">github</a></li>
     <li><a href="https://twitter.com/Searx_engine">twitter</a></li>
     <li>IRC: #searx @ freenode (<a href="https://kiwiirc.com/client/irc.freenode.com/searx">webclient</a>)</li>
     <li><a href="https://www.transifex.com/projects/p/searx/">transifex</a></li>
-</ul>
+  </ul>
 
+  <hr />
 
-<hr />
+  <h2>Technical details - How does it work?</h2>
 
-<h2 id="faq">FAQ</h2>
+  <p>
+    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    inspired by the <a href="https://beniz.github.io/seeks/">seeks project</a>.
 
-<h3>How to add to firefox?</h3>
-<p><a href="#" onclick="window.external.AddSearchProvider(window.location.protocol + '//' + window.location.host + '{{ url_for('opensearch') }}');">Install</a> searx as a search engine on any version of Firefox! (javascript required)</p>
+    It provides basic privacy by mixing your queries with searches on other
+    platforms without storing search data. Queries are made using a POST request
+    on every browser (except chrome*).  Therefore they show up in neither our
+    logs, nor your url history.  In case of Chrome* users there is an exception,
+    searx uses the search bar to perform GET requests.
 
-<h2 id="dev_faq">Developer FAQ</h2>
+    Searx can be added to your browser's search bar; moreover, it can be set as
+    the default search engine.
+  </p>
 
-<h3>New engines?</h3>
-<ul>
-    <li>Edit your <a href="https://github.com/asciimoo/searx/blob/master/searx/settings.yml">settings.yml</a></li>
-    <li>Create your custom engine module, check the <a href="https://github.com/asciimoo/searx/blob/master/examples/basic_engine.py">example engine</a></li>
-</ul>
-<p>Don't forget to restart searx after config edit!</p>
+  <h2>Why use searx?</h2>
 
-<h3>Installation/WSGI support?</h3>
-<p>See the <a href="{{ brand.DOCS_URL }}/admin/installation.html#uwsgi">installation and uwsgi setup</a></p>
+  <ul>
+    <li>
+      Searx may not offer you as personalised results as Google, but it doesn't
+      generate a profile about you.
+    </li>
+    <li>
+      Searx doesn't care about what you search for, never shares anything with a
+      third party, and it can't be used to compromise you.
+    </li>
+    <li>
+      Searx is free software, the code is 100% open and you can help to make it
+      better.  See more on <a href="https://github.com/asciimoo/searx">github</a>.
+    </li>
+  </ul>
+  <p>
+    If you do care about privacy, want to be a conscious user, or otherwise
+    believe in digital freedom, make searx your default search engine or run it
+    on your own server
+  </p>
 
-<h3>How to debug engines?</h3>
-<p><a href="{{ url_for('stats') }}">Stats page</a> contains some useful data about the engines used.</p>
+  <h2 id='add to browser'>Can it be set as the default search engine?</h2>
+
+  <dt>Firefox</dt>
+
+  <dd>
+    <a href="#" onclick="window.external.AddSearchProvider(window.location.protocol + '//' + window.location.host + '{{ url_for('opensearch') }}');">Install</a>
+    searx as a search engine on any version of Firefox! (javascript required)
+  </dd>
+
+  <h2>How to debug engines?</h2>
+
+  <p>
+    <a href="{{ url_for('stats') }}">Stats page</a> contains some useful data about the engines used.
+  </p>
+
+  <h2>How can I make it my own?</h2>
+
+  <p>
+    Searx appreciates your concern regarding logs, so take the
+    code from the <a href="https://github.com/asciimoo/searx">orgin searx projekct</a> and
+    run it yourself!
+  </p>
+  <p>
+    Add your searx instance to this <a href="{{ brand.PUBLIC_INSTANCES }}"> list
+    of public searx instances</a> to help other people reclaim their privacy and
+    make the Internet freer!  The more decentralized the Internet is, the more
+    freedom we have!
+  </p>
+
+  <h2>Where are the docs & code of this instance?</h2>
+
+  <p>
+    See the <a href="{{ brand.DOCS_URL }}">{{ brand.DOCS_URL }}</a>
+    and <a href="{{ brand.GIT_URL }}">{{ brand.GIT_URL }}</a>
+  </p>
 
 </div>
 {% include "__common__/aboutextend.html" ignore missing %}

From 00251d7c66e60dc9859bf6368ab68d545660b90e Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 13:32:08 +0100
Subject: [PATCH 14/25] Makefile: add target 'useragents.update' to fetch
 versions of Firefox

Update searx/data/useragents.json with the most recent versions of Firefox.

BTW: add 'useragents.update' to 'project' target and clean up the Makefile and
remove it from the manage.sh script.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

closes: https://github.com/asciimoo/searx/issues/1882
---
 Makefile  | 19 +++++++++++++------
 manage.sh |  6 ------
 2 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/Makefile b/Makefile
index 2bea06c9d..89e83dc59 100644
--- a/Makefile
+++ b/Makefile
@@ -74,14 +74,21 @@ $(GH_PAGES)::
 # update project files
 # --------------------
 
-PHONY += project engines-languages searx.brand
+PHONY += project engines.languages searx.brand useragents.update
 
-project: searx/data/engines_languages.json searx.brand
+project: useragents.update engines.languages searx.brand
 
-engines-languages:  pyenvinstall
-	$(PY_ENV_ACT); python utils/fetch_languages.py
-	mv engines_languages.json searx/data/engines_languages.json
-	mv languages.py searx/languages.py
+engines.languages:  pyenvinstall
+	$(Q)echo "fetch languages .."
+	$(Q)$(PY_ENV_ACT); python utils/fetch_languages.py
+	$(Q)echo "update searx/data/engines_languages.json"
+	$(Q)mv engines_languages.json searx/data/engines_languages.json
+	$(Q)echo "update searx/languages.py"
+	$(Q)mv languages.py searx/languages.py
+
+useragents.update:  pyenvinstall
+	$(Q)echo "Update searx/data/useragents.json with the most recent versions of Firefox."
+	$(Q)$(PY_ENV_ACT); python utils/fetch_firefox_version.py
 
 searx.brand:
 	$(Q)echo "build searx/brand.py"
diff --git a/manage.sh b/manage.sh
index 4c11576a3..5c9b332aa 100755
--- a/manage.sh
+++ b/manage.sh
@@ -70,11 +70,6 @@ locales() {
     pybabel compile -d "$SEARX_DIR/translations"
 }
 
-update_useragents() {
-    echo '[!] Updating user agent versions'
-    python utils/fetch_firefox_version.py
-}
-
 pep8_check() {
     echo '[!] Running pep8 check'
     # ignored rules:
@@ -242,7 +237,6 @@ Commands
     update_dev_packages  - Check & update development and production dependency changes
     install_geckodriver  - Download & install geckodriver if not already installed (required for robot_tests)
     npm_packages         - Download & install npm dependencies
-    update_useragents    - Update useragents.json with the most recent versions of Firefox
 
     Build
     -----

From 809e6f7933bac4b68b9c4bc997c34b9e75db92ee Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 13:35:17 +0100
Subject: [PATCH 15/25] make project: re-build generic files of the searx
 project

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/data/useragents.json | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/searx/data/useragents.json b/searx/data/useragents.json
index abb81000c..5ba8c5be8 100644
--- a/searx/data/useragents.json
+++ b/searx/data/useragents.json
@@ -1,11 +1,8 @@
 {
     "versions": [
-        "70.0.1",
-        "70.0",
-        "69.0.3",
-        "69.0.2",
-        "69.0.1",
-        "69.0"
+        "74.0",
+        "73.0.1",
+        "73.0"
     ],
     "os": [
         "Windows NT 10; WOW64",

From 971752198156e6a2a4ade127032d35c54ea3563b Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 13:45:37 +0100
Subject: [PATCH 16/25] Minor improvements of the HTML *about* page

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 searx/templates/__common__/about.html | 39 ++++++++++++++-------------
 1 file changed, 20 insertions(+), 19 deletions(-)

diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html
index c912a8bd2..5c91c3394 100644
--- a/searx/templates/__common__/about.html
+++ b/searx/templates/__common__/about.html
@@ -18,22 +18,6 @@
 
   <hr />
 
-  <h2>Technical details - How does it work?</h2>
-
-  <p>
-    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
-    inspired by the <a href="https://beniz.github.io/seeks/">seeks project</a>.
-
-    It provides basic privacy by mixing your queries with searches on other
-    platforms without storing search data. Queries are made using a POST request
-    on every browser (except chrome*).  Therefore they show up in neither our
-    logs, nor your url history.  In case of Chrome* users there is an exception,
-    searx uses the search bar to perform GET requests.
-
-    Searx can be added to your browser's search bar; moreover, it can be set as
-    the default search engine.
-  </p>
-
   <h2>Why use searx?</h2>
 
   <ul>
@@ -50,13 +34,30 @@
       better.  See more on <a href="https://github.com/asciimoo/searx">github</a>.
     </li>
   </ul>
+
   <p>
     If you do care about privacy, want to be a conscious user, or otherwise
     believe in digital freedom, make searx your default search engine or run it
     on your own server
   </p>
 
-  <h2 id='add to browser'>Can it be set as the default search engine?</h2>
+  <h2>Technical details - How does it work?</h2>
+
+  <p>
+    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    inspired by the <a href="https://beniz.github.io/seeks/">seeks project</a>.
+
+    It provides basic privacy by mixing your queries with searches on other
+    platforms without storing search data. Queries are made using a POST request
+    on every browser (except chrome*).  Therefore they show up in neither our
+    logs, nor your url history.  In case of Chrome* users there is an exception,
+    searx uses the search bar to perform GET requests.
+
+    Searx can be added to your browser's search bar; moreover, it can be set as
+    the default search engine.
+  </p>
+
+  <h2 id='add to browser'>How to set as the default search engine?</h2>
 
   <dt>Firefox</dt>
 
@@ -65,7 +66,7 @@
     searx as a search engine on any version of Firefox! (javascript required)
   </dd>
 
-  <h2>How to debug engines?</h2>
+  <h2>Where to find anonymous usage statistics of this instance ?</h2>
 
   <p>
     <a href="{{ url_for('stats') }}">Stats page</a> contains some useful data about the engines used.
@@ -75,7 +76,7 @@
 
   <p>
     Searx appreciates your concern regarding logs, so take the
-    code from the <a href="https://github.com/asciimoo/searx">orgin searx projekct</a> and
+    code from the <a href="https://github.com/asciimoo/searx">orgin searx project</a> and
     run it yourself!
   </p>
   <p>

From 6846402d734c9f4f7fb68fb3980aa2ada5adb763 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 15:35:32 +0100
Subject: [PATCH 17/25] .gitignore: make package-lock.json visible

Even if we do not versioning them right now.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 .gitignore                            | 1 -
 searx/static/themes/oscar/.gitignore  | 1 -
 searx/static/themes/simple/.gitignore | 1 -
 3 files changed, 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9e08e2a47..1c82be41b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,7 +16,6 @@ setup.cfg
 *~
 
 /node_modules
-/package-lock.json
 
 .tx/
 
diff --git a/searx/static/themes/oscar/.gitignore b/searx/static/themes/oscar/.gitignore
index 49e0fc6b4..07e6e472c 100644
--- a/searx/static/themes/oscar/.gitignore
+++ b/searx/static/themes/oscar/.gitignore
@@ -1,2 +1 @@
 /node_modules
-/package-lock.json
\ No newline at end of file
diff --git a/searx/static/themes/simple/.gitignore b/searx/static/themes/simple/.gitignore
index 49e0fc6b4..07e6e472c 100644
--- a/searx/static/themes/simple/.gitignore
+++ b/searx/static/themes/simple/.gitignore
@@ -1,2 +1 @@
 /node_modules
-/package-lock.json
\ No newline at end of file

From e7fbefa8bdecca04824b3ef744786d8bb45c35fe Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 18:00:07 +0100
Subject: [PATCH 18/25] build: move build styles from manage.sh to Makefile

To build all styles use:

  make styles

To build individual styles use one of:

  make style.legacy
  make style.courgette
  make style.pixart
  make style.bootstrap

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile  | 25 +++++++++++++++++++++++++
 manage.sh | 22 ----------------------
 2 files changed, 25 insertions(+), 22 deletions(-)

diff --git a/Makefile b/Makefile
index 89e83dc59..8b760093b 100644
--- a/Makefile
+++ b/Makefile
@@ -128,6 +128,31 @@ themes.simple:
 	$(Q)echo '[!] Grunt build : simple theme'
 	$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
 
+# build styles
+# ------------
+
+PHONY += styles style.legacy style.courgette style.pixart style.bootstrap
+styles: style.legacy style.courgette style.pixart style.bootstrap
+
+quiet_cmd_lessc = STYLE     $3
+      cmd_lessc = PATH="$$(npm bin):$$PATH" \
+	lessc --clean-css="--s1 --advanced --compatibility=ie9" "searx/static/$2" "searx/static/$3"
+
+style.legacy:
+	$(call cmd,lessc,themes/legacy/less/style-rtl.less,themes/legacy/css/style-rtl.css)
+	$(call cmd,lessc,themes/legacy/less/style.less,themes/legacy/css/style.css)
+
+style.courgette:
+	$(call cmd,lessc,themes/courgette/less/style.less,themes/courgette/css/style.css)
+	$(call cmd,lessc,themes/courgette/less/style-rtl.less,themes/courgette/css/style-rtl.css)
+
+style.pixart:
+	$(call cmd,lessc,themes/pix-art/less/style.less,themes/pix-art/css/style.css)
+
+style.bootstrap:
+	$(call cmd,lessc,less/bootstrap/bootstrap.less,css/bootstrap.min.css)
+
+
 # docker
 # ------
 
diff --git a/manage.sh b/manage.sh
index 5c9b332aa..4f46fd6d7 100755
--- a/manage.sh
+++ b/manage.sh
@@ -130,27 +130,6 @@ npm_packages() {
     npm install
 }
 
-build_style() {
-    npm_path_setup
-
-    lessc --clean-css="--s1 --advanced --compatibility=ie9" "$BASE_DIR/searx/static/$1" "$BASE_DIR/searx/static/$2"
-}
-
-styles() {
-    npm_path_setup
-
-    echo '[!] Building legacy style'
-    build_style themes/legacy/less/style.less themes/legacy/css/style.css
-    build_style themes/legacy/less/style-rtl.less themes/legacy/css/style-rtl.css
-    echo '[!] Building courgette style'
-    build_style themes/courgette/less/style.less themes/courgette/css/style.css
-    build_style themes/courgette/less/style-rtl.less themes/courgette/css/style-rtl.css
-    echo '[!] Building pix-art style'
-    build_style themes/pix-art/less/style.less themes/pix-art/css/style.css
-    echo '[!] Building bootstrap style'
-    build_style less/bootstrap/bootstrap.less css/bootstrap.min.css
-}
-
 docker_build() {
     # Check if it is a git repository
     if [ ! -d .git ]; then
@@ -241,7 +220,6 @@ Commands
     Build
     -----
     locales              - Compile locales
-    styles               - Build less files
 
     Tests
     -----

From 1075f58a722fad7801a7b8397cd7e6de31d99da2 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 18:41:45 +0100
Subject: [PATCH 19/25] test: move tests from manage.sh to Makefile

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile  | 45 +++++++++++++++++++++++++++++++++++----------
 manage.sh | 42 ------------------------------------------
 2 files changed, 35 insertions(+), 52 deletions(-)

diff --git a/Makefile b/Makefile
index 8b760093b..fe65acade 100644
--- a/Makefile
+++ b/Makefile
@@ -43,7 +43,7 @@ PHONY += uninstall
 uninstall: pyenvuninstall
 
 PHONY += clean
-clean: pyclean node.clean
+clean: pyclean node.clean test.clean
 	$(call cmd,common_clean)
 
 PHONY += run
@@ -160,27 +160,52 @@ PHONY += docker
 docker:
 	$(Q)./manage.sh docker_build
 
+# gecko
+# -----
+
+PHONY += gecko.driver
+gecko.driver:
+	$(PY_ENV_ACT); ./manage.sh install_geckodriver
 
 # test
 # ----
 
-PHONY += test test.pylint test.pep8 test.unit test.robot
+PHONY += test test.pylint test.pep8 test.unit test.coverage test.robot
 
-test: test.pylint test.pep8 test.unit test.robot
+test: test.pylint test.pep8 test.unit gecko.driver test.robot
 
 # TODO: balance linting with pylint
 test.pylint: pyenvinstall
-	$(call cmd,pylint,searx/preferences.py)
-	$(call cmd,pylint,searx/testing.py)
+	$(call cmd,pylint,\
+		searx/preferences.py \
+		searx/testing.py \
+	)
+
+# ignored rules:
+#  E402 module level import not at top of file
+#  W503 line break before binary operator
 
 test.pep8: pyenvinstall
-	$(PY_ENV_ACT); ./manage.sh pep8_check
+	@echo "TEST      pep8"
+	$(Q)$(PY_ENV_ACT); pep8 --exclude=searx/static --max-line-length=120 --ignore "E402,W503" searx tests
 
 test.unit: pyenvinstall
-	$(PY_ENV_ACT); ./manage.sh unit_tests
+	@echo "TEST      tests/unit"
+	$(Q)$(PY_ENV_ACT); python -m nose2 -s tests/unit
 
-test.robot: pyenvinstall
-	$(PY_ENV_ACT); ./manage.sh install_geckodriver
-	$(PY_ENV_ACT); ./manage.sh robot_tests
+test.coverage:  pyenvinstall
+	@echo "TEST      unit test coverage"
+	$(Q)$(PY_ENV_ACT); \
+	python -m nose2 -C --log-capture --with-coverage --coverage searx -s tests/unit \
+	&& coverage report \
+	&& coverage html \
+
+test.robot: pyenvinstall gecko.driver
+	@echo "TEST      robot"
+	$(Q)$(PY_ENV_ACT); PYTHONPATH=. python searx/testing.py robot
+
+test.clean:
+	@echo "CLEAN     intermediate test stuff"
+	$(Q)rm -rf geckodriver.log .coverage coverage/
 
 .PHONY: $(PHONY)
diff --git a/manage.sh b/manage.sh
index 4f46fd6d7..6667274b1 100755
--- a/manage.sh
+++ b/manage.sh
@@ -70,40 +70,6 @@ locales() {
     pybabel compile -d "$SEARX_DIR/translations"
 }
 
-pep8_check() {
-    echo '[!] Running pep8 check'
-    # ignored rules:
-    #  E402 module level import not at top of file
-    #  W503 line break before binary operator
-    pep8 --exclude=searx/static --max-line-length=120 --ignore "E402,W503" "$SEARX_DIR" "$BASE_DIR/tests"
-}
-
-unit_tests() {
-    echo '[!] Running unit tests'
-    python -m nose2 -s "$BASE_DIR/tests/unit"
-}
-
-py_test_coverage() {
-    echo '[!] Running python test coverage'
-    PYTHONPATH="`pwd`" python -m nose2 -C --log-capture --with-coverage --coverage "$SEARX_DIR" -s "$BASE_DIR/tests/unit" \
-    && coverage report \
-    && coverage html
-}
-
-robot_tests() {
-    echo '[!] Running robot tests'
-    PYTHONPATH="`pwd`" python "$SEARX_DIR/testing.py" robot
-}
-
-tests() {
-    set -e
-    pep8_check
-    unit_tests
-    install_geckodriver
-    robot_tests
-    set +e
-}
-
 
 #
 # Web
@@ -220,14 +186,6 @@ Commands
     Build
     -----
     locales              - Compile locales
-
-    Tests
-    -----
-    unit_tests           - Run unit tests
-    pep8_check           - Pep8 validation
-    robot_tests          - Run selenium tests
-    tests                - Run all python tests (pep8, unit, robot_tests)
-    py_test_coverage     - Unit test coverage
 "
 }
 

From d7523071a0ba8c210f7ece31d8e30f5c360966c3 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Mar 2020 19:14:07 +0100
Subject: [PATCH 20/25] travis: use build environment from Makefile

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 .travis.yml | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index e37b65864..ca986d04d 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,8 +1,6 @@
 language: python
 sudo: false
 cache:
-  - pip
-  - npm
   - directories:
     - $HOME/.cache/pip
 
@@ -10,17 +8,16 @@ addons:
   firefox: "latest"
 
 install:
-  - ./manage.sh install_geckodriver ~/drivers
-  - export PATH=~/drivers:$PATH
-  - ./manage.sh npm_packages
-  - ./manage.sh update_dev_packages
-  - pip install codecov
+  - make install
+  - make gecko.driver
+  - make node.env
+  - local/py3/bin/pip install codecov
 script:
-  - ./manage.sh styles
-  - ./manage.sh grunt_build
-  - ./manage.sh tests
+  - make styles
+  - make themes
+  - make test
 after_success:
-  - ./manage.sh py_test_coverage
+  - make test.coverage
   - codecov
 
 stages:
@@ -44,7 +41,7 @@ jobs:
       install: true
       script:
         - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
-        - ./manage.sh docker_build push
+        - local/py3/bin/activate; ./manage.sh docker_build push
       after_success: true
 
 notifications:

From ec453e0239dcaa6edefe7f50567f2da2eec77b5d Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sun, 29 Mar 2020 11:06:22 +0200
Subject: [PATCH 21/25] [fix] docker 'Error compiling' and 'SyntaxError'
 messages

The make docker target spits out some SyntaxError.  With this .dockerignore
there is no more error. Explanation:

- the python files are compiled while building the docker image
- a node modules contains some python files
- the python files inside the node module doesn't compile

It raises the fact that node_modules were included in the docker image which
should not happen.  Same the local directory was included.  Dockerfile builds
searx in its own way (without virtualenv)

Thanks @dalf:

- https://github.com/asciimoo/searx/pull/1900#issuecomment-604892737

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 .dockerignore | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/.dockerignore b/.dockerignore
index f4d03376c..044460b20 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -4,6 +4,9 @@
 */*/*/*~
 */*/*/*/*~
 
+#
+local/
+
 # Git
 .git
 .gitignore
@@ -36,6 +39,11 @@ robot_report.html
 test_basic/
 setup.cfg
 
+# node_modules
 node_modules/
+*/node_modules/
+*/*/node_modules/
+*/*/*/node_modules/
+*/*/*/*/node_modules/
 
 .tx/
\ No newline at end of file

From 8a16903a1ca980fc3c670e304067c9e68eb59a25 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sun, 29 Mar 2020 11:29:57 +0200
Subject: [PATCH 22/25] make themes: rename 'style' targtes to 'themes' targets

style.legacy could be renamed themes.legacy : it actually builds the files for
the legacy theme, then themes.legacy can be a dependency of themes.  Same for
the other styles.*

Debatable: about style.bootstrap, same convention : theme.bootstrap (even it is
more a toolbox for the oscar theme).

So there is no need to add the missing make styles in the help target.

thanks @dalf:

- https://github.com/asciimoo/searx/pull/1900#discussion_r399160355

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile | 43 ++++++++++++++++++++++---------------------
 1 file changed, 22 insertions(+), 21 deletions(-)

diff --git a/Makefile b/Makefile
index fe65acade..5b890374e 100644
--- a/Makefile
+++ b/Makefile
@@ -117,39 +117,40 @@ node.clean:
 # build themes
 # ------------
 
-PHONY += themes themes.oscar themes.simple
-themes: themes.oscar themes.simple
+PHONY += themes.bootstrap themes themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
+themes: themes.bootstrap themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
 
-themes.oscar:
-	$(Q)echo '[!] Grunt build : oscar theme'
-	$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile  "searx/static/themes/oscar/gruntfile.js"
-
-themes.simple:
-	$(Q)echo '[!] Grunt build : simple theme'
-	$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile  "searx/static/themes/simple/gruntfile.js"
-
-# build styles
-# ------------
-
-PHONY += styles style.legacy style.courgette style.pixart style.bootstrap
-styles: style.legacy style.courgette style.pixart style.bootstrap
-
-quiet_cmd_lessc = STYLE     $3
+quiet_cmd_lessc = LESSC     $3
       cmd_lessc = PATH="$$(npm bin):$$PATH" \
 	lessc --clean-css="--s1 --advanced --compatibility=ie9" "searx/static/$2" "searx/static/$3"
 
-style.legacy:
+quiet_cmd_grunt = GRUNT     $2
+      cmd_grunt = PATH="$$(npm bin):$$PATH" \
+	grunt --gruntfile  "$2"
+
+themes.oscar:
+	$(Q)echo '[!] build oscar theme'
+	$(call cmd,grunt,searx/static/themes/oscar/gruntfile.js)
+
+themes.simple:
+	$(Q)echo '[!] build simple theme'
+	$(call cmd,grunt,searx/static/themes/simple/gruntfile.js)
+
+themes.legacy:
+	$(Q)echo '[!] build legacy theme'
 	$(call cmd,lessc,themes/legacy/less/style-rtl.less,themes/legacy/css/style-rtl.css)
 	$(call cmd,lessc,themes/legacy/less/style.less,themes/legacy/css/style.css)
 
-style.courgette:
+themes.courgette:
+	$(Q)echo '[!] build courgette theme'
 	$(call cmd,lessc,themes/courgette/less/style.less,themes/courgette/css/style.css)
 	$(call cmd,lessc,themes/courgette/less/style-rtl.less,themes/courgette/css/style-rtl.css)
 
-style.pixart:
+themes.pixart:
+	$(Q)echo '[!] build pixart theme'
 	$(call cmd,lessc,themes/pix-art/less/style.less,themes/pix-art/css/style.css)
 
-style.bootstrap:
+themes.bootstrap:
 	$(call cmd,lessc,less/bootstrap/bootstrap.less,css/bootstrap.min.css)
 
 

From 442b27ac1b1f54669fbb9785d780327f62814431 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sun, 29 Mar 2020 11:41:59 +0200
Subject: [PATCH 23/25] bash: use build environment from Makefile

To Makefile target brand, add creation of bash environment in::

  utils/brand.env

In bash scripts (manage.sh) source env by::

  . utils/brand.env

manage.sh help: show GIT_URL and more environment

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile        | 7 +++++++
 manage.sh       | 8 ++++++++
 utils/brand.env | 5 +++++
 3 files changed, 20 insertions(+)
 create mode 100644 utils/brand.env

diff --git a/Makefile b/Makefile
index 5b890374e..d09e92828 100644
--- a/Makefile
+++ b/Makefile
@@ -97,6 +97,13 @@ searx.brand:
 	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
 	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
 	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
+	$(Q)echo "build utils/brand.env"
+	$(Q)echo "export GIT_URL='$(GIT_URL)'"  > utils/brand.env
+	$(Q)echo "export ISSUE_URL='https://github.com/asciimoo/searx/issues'" >> utils/brand.env
+	$(Q)echo "export SEARX_URL='$(SEARX_URL)'" >> utils/brand.env
+	$(Q)echo "export DOCS_URL='$(DOCS_URL)'" >> utils/brand.env
+	$(Q)echo "export PUBLIC_INSTANCES='https://searx.space'" >> utils/brand.env
+
 
 # node / npm
 # ----------
diff --git a/manage.sh b/manage.sh
index 6667274b1..4831fc1fa 100755
--- a/manage.sh
+++ b/manage.sh
@@ -10,6 +10,7 @@ PYTHONPATH="$BASE_DIR"
 SEARX_DIR="$BASE_DIR/searx"
 ACTION="$1"
 
+. "${BASE_DIR}/utils/brand.env"
 
 #
 # Python
@@ -186,6 +187,13 @@ Commands
     Build
     -----
     locales              - Compile locales
+
+Environment:
+    GIT_URL:          ${GIT_URL}
+    ISSUE_URL:        ${ISSUE_URL}
+    SEARX_URL:        ${SEARX_URL}
+    DOCS_URL:         ${DOCS_URL}
+    PUBLIC_INSTANCES: ${PUBLIC_INSTANCES}
 "
 }
 
diff --git a/utils/brand.env b/utils/brand.env
new file mode 100644
index 000000000..7fe1a3911
--- /dev/null
+++ b/utils/brand.env
@@ -0,0 +1,5 @@
+export GIT_URL='https://github.com/asciimoo/searx'
+export ISSUE_URL='https://github.com/asciimoo/searx/issues'
+export SEARX_URL='https://searx.me'
+export DOCS_URL='https://asciimoo.github.io/searx'
+export PUBLIC_INSTANCES='https://searx.space'

From ca65d41da569834435c226407370365224d7867c Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sun, 29 Mar 2020 12:22:02 +0200
Subject: [PATCH 24/25] [fix] travis: reomve 'make style' from travis build

Commit 8a16903a removes Makefile target style

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 .travis.yml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/.travis.yml b/.travis.yml
index ca986d04d..1667cd37c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -13,7 +13,6 @@ install:
   - make node.env
   - local/py3/bin/pip install codecov
 script:
-  - make styles
   - make themes
   - make test
 after_success:

From 1ae39787c1d19a6781ad3d5cb0b2615741d9eb4b Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Mon, 30 Mar 2020 12:23:01 +0200
Subject: [PATCH 25/25] Makefile: rename target 'searx.brand' to 'buildenv'

And add 'buildenv' as an first order prerequisite to the main targets:

- install
- run
- docs
- docs-live
- project
- node.env
- docker
- test

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 Makefile | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/Makefile b/Makefile
index d09e92828..a093d8b18 100644
--- a/Makefile
+++ b/Makefile
@@ -28,6 +28,7 @@ help:
 	@echo  '  gh-pages  - build docs & deploy on gh-pages branch'
 	@echo  '  clean     - drop builds and environments'
 	@echo  '  project   - re-build generic files of the searx project'
+	@echo  '  buildenv  - re-build environment files (aka brand)'
 	@echo  '  themes    - re-build build the source of the themes'
 	@echo  '  docker    - build Docker image'
 	@echo  '  node.env  - download & install npm dependencies locally'
@@ -37,7 +38,7 @@ help:
 	@$(MAKE) -s -f utils/makefile.python python-help
 
 PHONY += install
-install: pyenvinstall
+install: buildenv pyenvinstall
 
 PHONY += uninstall
 uninstall: pyenvuninstall
@@ -47,7 +48,7 @@ clean: pyclean node.clean test.clean
 	$(call cmd,common_clean)
 
 PHONY += run
-run:  pyenvinstall
+run:  buildenv pyenvinstall
 	$(Q) ( \
 	sed -i -e "s/debug : False/debug : True/g" ./searx/settings.yml ; \
 	sleep 2 ; \
@@ -61,11 +62,11 @@ run:  pyenvinstall
 # ----
 
 PHONY += docs
-docs:  pyenvinstall sphinx-doc
+docs:  buildenv pyenvinstall sphinx-doc
 	$(call cmd,sphinx,html,docs,docs)
 
 PHONY += docs-live
-docs-live:  pyenvinstall sphinx-live
+docs-live:  buildenv pyenvinstall sphinx-live
 	$(call cmd,sphinx_autobuild,html,docs,docs)
 
 $(GH_PAGES)::
@@ -74,9 +75,9 @@ $(GH_PAGES)::
 # update project files
 # --------------------
 
-PHONY += project engines.languages searx.brand useragents.update
+PHONY += project engines.languages useragents.update buildenv
 
-project: useragents.update engines.languages searx.brand
+project: buildenv useragents.update engines.languages
 
 engines.languages:  pyenvinstall
 	$(Q)echo "fetch languages .."
@@ -90,7 +91,7 @@ useragents.update:  pyenvinstall
 	$(Q)echo "Update searx/data/useragents.json with the most recent versions of Firefox."
 	$(Q)$(PY_ENV_ACT); python utils/fetch_firefox_version.py
 
-searx.brand:
+buildenv:
 	$(Q)echo "build searx/brand.py"
 	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py
 	$(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py
@@ -108,7 +109,7 @@ searx.brand:
 # node / npm
 # ----------
 
-node.env:
+node.env: buildenv
 	$(Q)./manage.sh npm_packages
 
 node.clean:
@@ -125,7 +126,7 @@ node.clean:
 # ------------
 
 PHONY += themes.bootstrap themes themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
-themes: themes.bootstrap themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
+themes: buildenv themes.bootstrap themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
 
 quiet_cmd_lessc = LESSC     $3
       cmd_lessc = PATH="$$(npm bin):$$PATH" \
@@ -165,7 +166,7 @@ themes.bootstrap:
 # ------
 
 PHONY += docker
-docker:
+docker: buildenv
 	$(Q)./manage.sh docker_build
 
 # gecko
@@ -180,7 +181,7 @@ gecko.driver:
 
 PHONY += test test.pylint test.pep8 test.unit test.coverage test.robot
 
-test: test.pylint test.pep8 test.unit gecko.driver test.robot
+test: buildenv test.pylint test.pep8 test.unit gecko.driver test.robot
 
 # TODO: balance linting with pylint
 test.pylint: pyenvinstall