Markus Heiser
a5eefea61d
docs: fix extlink 'origin' to use GIT_BRANCH env
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-04 13:26:43 +01:00
Markus Heiser
9278f0fb45
docs: add some documentation about the tooling box ./utils/*
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-04 13:13:17 +01:00
Markus Heiser
8ca86f46d3
.config.sh: wrap up to use environment from Makefile as best defaults
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-04 10:43:48 +01:00
Markus Heiser
79e1f837ef
utils & Makefile: add .config.mk & .config.sh for searx brands
...
By isolating the environment of makefiles and bash scripts into .config.mk and
.config.sh it is simple to maintain searx brands by setting some central
environments.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-04 10:39:42 +01:00
Markus Heiser
94ac560dcc
doc: add descriptions of our tooling box in ./utils
...
Initial started with the scripts for searx, filtron and morty installations.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-03 13:25:51 +01:00
Markus Heiser
e7401796f6
utils/morty.sh: fixed public url
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-02 18:20:20 +01:00
Markus Heiser
a4437c47ac
utils/morty.sh: add script to install morty result proxy
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-02 18:14:10 +01:00
Markus Heiser
709ac51d33
utils/filtron.sh: generalize systemd, accounts and golang tasks
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-02-01 16:59:27 +01:00
Markus Heiser
56a93ee770
utils/lib.sh: colorize messages
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-31 18:24:31 +01:00
Markus Heiser
1e3d2f6800
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
2020-01-31 17:27:52 +01:00
Markus Heiser
0bb8847087
utils/filtron.sh: add option to debug filtron requests
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-31 17:25:38 +01:00
Markus Heiser
91a55e159e
apache: reverse proxy, set ProxyPreserveHost On
...
related discussions:
- https://github.com/asciimoo/searx/issues/1822
- https://github.com/asciimoo/searx/issues/1819#issuecomment-580400259
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-31 15:54:07 +01:00
Markus Heiser
cd9b877c8c
utils/searx.sh & filtron.sh: misc changes from first tests (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-31 15:53:53 +01:00
Markus Heiser
6274a54746
utils/searx.sh & filtron.sh: misc changes from first tests (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-30 19:55:51 +01:00
Markus Heiser
924bf65517
utils/searx.sh & filtron.sh: misc changes from first tests (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-29 20:00:50 +01:00
Markus Heiser
54675c7690
Merge pull request #1766 from dalf/fix-infinite-scroll
...
[mod] infinite scroll: XHR requests are sent with the header "Accept: text/html"
2020-01-28 11:04:02 +00:00
Markus Heiser
e64ff38217
Merge branch 'master' into fix-infinite-scroll
2020-01-28 10:59:03 +00:00
Markus Heiser
971a8264b2
utils/searx.sh: add apache site searx.conf:uwsgi (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-27 19:08:40 +01:00
Markus Heiser
d171fcd56e
utils/searx.sh: add apache site searx.conf:uwsgi
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-21 18:38:57 +01:00
Markus Heiser
af2f58fc58
utils/filtron.sh: add script to install filtron middleware (apache)
...
Preparation for the installation of an apache site.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-20 19:08:56 +01:00
Markus Heiser
9b5a7f7559
utils/searx.sh: add script to install isolated searx service
...
First version which serves searx over uwsgi at http://127.0.0.1:8888
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-20 16:55:05 +01:00
Markus Heiser
89df9d9141
utils/searx.sh: add script to install isolated searx service (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-16 14:01:38 +01:00
Markus Heiser
3cf31528f3
utils/searx.sh: add script to install isolated searx service (WIP)
...
WIP: written from scratch / linted but untested
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-14 19:26:54 +01:00
Markus Heiser
58a9fa93f6
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
2020-01-13 18:40:09 +01:00
Markus Heiser
c2b27d9120
Merge branch 'filtron' of https://github.com/return42/searx into filtron
2020-01-13 18:39:46 +01:00
Markus Heiser
b5449ec47c
filtron: log suspiciously frequent queries (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-13 18:37:05 +01:00
Markus Heiser
fe64274fb0
docs: filtron.sh add remark about init systems
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-12 15:53:35 +01:00
Markus Heiser
3ed82a97af
utils/filtron.sh: add command 'update filtron'
...
BTW: tidy up some code style and fix some issues reported by the linter.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-12 15:51:04 +01:00
Markus Heiser
bda1895655
Merge pull request #1804 from unixfox/patch-1
...
searx.be stopped using Fathom analytics
2020-01-12 11:25:47 +00:00
Markus Heiser
39feb141bc
docs(admin): add description of the utils/filtron.sh script
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-11 12:50:40 +01:00
Markus Heiser
876988a34f
docs: add Sphinx-doc extension sphinxcontrib.programoutput
...
- https://github.com/NextThought/sphinxcontrib-programoutput
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-11 12:49:02 +01:00
Markus Heiser
4990b07b4b
utils/filtron.sh: various fix from first installation test (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-09 16:25:05 +01:00
Markus Heiser
f20193155a
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
2020-01-08 19:22:24 +01:00
Markus Heiser
4139c63d23
utils/filtron.sh: add script to install filtron middleware
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-08 19:21:07 +01:00
Markus Heiser
28dacee288
utils: add lib.sh containing common shell script
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-08 18:13:22 +01:00
Markus Heiser
bdf392093a
build requirements: add a shell script static analysis tool
...
ShellCheck: https://github.com/koalaman/shellcheck
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-08 18:09:36 +01:00
Markus Heiser
22d05b3e59
Merge pull request #1791 from return42/add-docs
...
misc docs
2020-01-06 14:28:24 +00:00
Markus Heiser
86b5163641
docs: move wiki/Searx-instances from wiki to docs
...
fix project link in conf.py
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-06 15:06:36 +01:00
Markus Heiser
f521a279ac
Merge branch 'master' of https://github.com/asciimoo/searx into add-docs
2020-01-06 14:32:34 +01:00
Markus Heiser
0f4f0e517e
docs(user): move wiki/Searx-instances from wiki to docs
...
fixed some reST markups
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-06 14:31:18 +01:00
Markus Heiser
a3bbf95ad5
Merge pull request #1781 from finn0/bug/oscar-theme
...
Oscar: move info box at top of the page
2020-01-06 08:16:22 +00:00
Markus Heiser
1d86d0054f
Merge branch 'master' into bug/oscar-theme
2020-01-06 08:05:29 +00:00
Markus Heiser
3bb97fcb84
docs(user): public instances, fix Searxes@Danwin entry
...
fixes: https://github.com/asciimoo/searx/issues/1770
This is not Searx at all. This is Meta-Searx with other engines.
See https://github.com/asciimoo/searx/issues/1770#issuecomment-570776655
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-05 10:02:42 +01:00
Markus Heiser
200c3a31f5
docs(user): move wiki/Searx-instances from wiki to docs (WIP)
...
Move wiki entry https://github.com/asciimoo/searx/wiki/Searx-instances
into user section of the docs (#1785 ).
links has been ported from markdown to reST by::
regexpr: \[([^\]]*)\]\(([^)]*)\)
substitution: `\1 <\2>`__
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-04 18:26:04 +01:00
Markus Heiser
7347d9b508
docs(user): move wiki/Searx-instances from wiki to docs
...
Move wiki entry https://github.com/asciimoo/searx/wiki/Searx-instances
into user section of the docs (#1785 ).
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-04 17:09:11 +01:00
Markus Heiser
51b9295b84
Merge branch 'master' of https://github.com/asciimoo/searx into add-docs
2020-01-03 14:30:53 +01:00
Markus Heiser
2a7855854b
Merge pull request #1623 from ypid/fix/nginx-subdir-hosting
...
Fix Nginx subdir URL install docs which allowed download of settings.yml
2019-12-31 16:26:21 +01:00
Markus Heiser
f602cb8e4d
docs(admin): moved settings description from wiki to docs
...
Move wiki entry https://github.com/asciimoo/searx/wiki/settings.yml
into admin section of the docs (#1785 ).
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-30 21:56:09 +01:00
Markus Heiser
f9be534b2a
docs(dev): fix minor markup typos
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-30 21:55:15 +01:00
Markus Heiser
10997a01e0
docs(admin): add weight & disabled cols to engine table
...
BTW: remove internal suspend_end_time
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-30 20:29:37 +01:00
Markus Heiser
754a10c1c1
Merge pull request #1661 from 0xhtml/fix-engine-spotify
...
Fix engine spotify
As you can read here https://developer.spotify.com/documentation/web-api/#authentication all requests to the spotify api require authentication. You can not test the api without credentials.
2019-12-30 07:44:31 +01:00
Markus Heiser
36e72a4619
Merge branch 'master' into fix-engine-spotify
2019-12-29 09:47:06 +01:00
Markus Heiser
f6d66c0f6f
Merge pull request #1776 from return42/makefile-doc
...
doc: describe Makefile targets & add reST primer
2019-12-28 13:55:20 +01:00
Markus Heiser
b91e07bbf1
docs(css): render HTML rst-example slightly more discreet
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-28 01:26:24 +01:00
Markus Heiser
d1892b2112
docs(admin): add article 'Buildhosts' with system requirements
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-28 01:25:16 +01:00
Markus Heiser
d6f2802e4b
docs(dev): add more markups to reST primer
...
- Literal blocks
- Unicode substitution
- Horizontal list
- Math equations
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-28 01:01:11 +01:00
Markus Heiser
92afe68d65
doc(dev): reST/sphinx add tabbed views extension (sphinx_tabs.tabs)
...
See issue #1785 :
idea: in the doc, provide installation instructions with one tab per
distrubution
preview (don't bookmark):
https://return42.github.io/searx/dev/reST.html#tabbed-views
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-26 10:26:12 +01:00
Markus Heiser
62505f8982
docs(dev): add refs to to gitmoji and Semantic PR in contrib section
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-25 09:57:21 +01:00
Markus Heiser
4ca8b69c81
doc(dev): add remarks about creating good commits (messages)
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-24 18:48:23 +01:00
Markus Heiser
5eb8cf4ebb
Merge branch 'master' of https://github.com/asciimoo/searx into makefile-doc
2019-12-24 18:00:24 +01:00
Markus Heiser
a52a638ba8
Merge pull request #1701 from CaffeinatedTech/patch-1
...
Update README.rst
for the future: please select meaningful commit messages. Here is a good summarize how a useful commit messages looks like: https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary
Further read: https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages
2019-12-24 17:56:24 +01:00
Markus Heiser
ecb054a7a0
Merge branch 'master' into patch-1
2019-12-24 17:45:13 +01:00
Markus Heiser
5a0a66e9bc
Merge pull request #1615 from Nachtalb/ne/fix-infinite_scroll-with-vim_bindings
...
Fix not jumping to results loaded by infinite scroll
2019-12-24 17:34:33 +01:00
Markus Heiser
38dad2e8e3
Merge branch 'master' into ne/fix-infinite_scroll-with-vim_bindings
2019-12-24 15:42:05 +01:00
Markus Heiser
a395fb4a8d
Merge pull request #1694 from finn0/libgen
...
Fix broken Library Gensis Engine
2019-12-24 13:37:29 +01:00
Markus Heiser
fb668e2075
Merge branch 'master' into libgen
2019-12-24 13:33:07 +01:00
Markus Heiser
46dd51afad
Merge branch 'master' into makefile-doc
2019-12-24 12:27:36 +01:00
Markus Heiser
6d232e9b69
Merge pull request #1787 from finn0/fix/infobox
...
[Fix] oscar: no HTML escaping prior to output
2019-12-24 11:37:33 +01:00
Markus Heiser
70f7142824
Merge branch 'master' into bug/oscar-theme
2019-12-23 18:47:23 +01:00
Markus Heiser
07c8ca87e6
Merge branch 'master' into makefile-doc
2019-12-23 13:58:53 +00:00
Markus Heiser
3e14bf4d27
Merge pull request #1686 from MarcAbonce/wiki_infobox_fixes
...
Infobox fixes
2019-12-23 12:31:31 +00:00
Markus Heiser
c8645d6e37
doc: reST-primer -- imrpove desription of definition lists
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-23 09:37:51 +01:00
Markus Heiser
d3e4e81faf
makefile.sphinx: fix gh-pages / pull before add commits
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-22 23:28:07 +01:00
Markus Heiser
90174e215c
doc: add plugin section to admin section (template)
...
- Plugins configured at built time (defaults)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-22 23:26:06 +01:00
Markus Heiser
31db843c9c
doc: CSS - fix alignment of code block in figure blocks
...
BTW: minor profread of reST.rst
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-22 14:08:57 +01:00
Markus Heiser
aa3b0265e7
doc: add 'Architecture' article to admin section
...
Herein we add some hints and suggestions about typical architectures of
searx infrastructures. We start with a contribution from @dalf
- https://github.com/asciimoo/searx/pull/1776#issuecomment-567917320
thanks @dalf !!
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-22 14:05:33 +01:00
Markus Heiser
5bdca1a5bf
doc: improved HTML table layout (CSS)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-22 11:46:03 +01:00
Markus Heiser
aea4667fbc
Merge branch 'master' of https://github.com/asciimoo/searx into makefile-doc
2019-12-22 10:12:33 +01:00
Markus Heiser
d1154202bc
doc: add reST templating // incl. generic engine tabe
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-21 17:13:38 +01:00
Markus Heiser
c2b9aa0c2f
docs: reST-primer describe table markup (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-20 20:39:14 +01:00
Markus Heiser
b201f84595
docs: reST-primer continued proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-20 17:47:24 +01:00
Markus Heiser
ae7cb5937e
docs: reST-primer first proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-20 12:10:43 +01:00
Markus Heiser
b82f61f704
doc: reST primer -- describe admonitions & customize their CSS
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-20 11:01:41 +01:00
Markus Heiser
e1566e68aa
doc: add content to reST primer (WIP) // linuxdoc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-19 23:36:53 +01:00
Markus Heiser
bee19a76f7
doc: add reST primer (inital / WIP)
...
preview: https://return42.github.io/searx/dev/reST.html
includes:
- :class: rst-example // admonitions with (rendered) reST markup example
- extlinks to docutils
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-19 17:05:50 +01:00
Markus Heiser
2b4526916d
edoc: -- makefile.rst fix typo and add extlinks['man']
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-18 18:32:42 +01:00
Markus Heiser
f09459b98a
doc: describe Makefile targets
...
With the aim to simplify development cycles, started with PR #1756 a Makefile
based boilerplate was added. This patch adds the missing developer
documentation.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-18 16:11:05 +01:00
Markus Heiser
02d5173fb2
Makefile: remove trailing '/' from DOCS_URL
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-13 16:08:34 +01:00
Markus Heiser
fcd7f4cd12
doc: add note about docs-clean target
...
BTW: fix some typos
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-13 15:22:10 +01:00
Markus Heiser
e4e578e8a9
doc: theme - make sidebar less eye-catching
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-13 14:58:13 +01:00
Markus Heiser
97b86fd184
doc: document the new reST & gh-pages workflow
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-13 14:57:07 +01:00
Markus Heiser
121f696460
Makefile: gh-pages: keep history of gh-branch intact (don't drop)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-13 12:58:46 +01:00
Markus Heiser
04eeeb53a1
doc: moved reST sources in the right folder (much clearer)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 19:48:42 +01:00
Markus Heiser
e9fff4fde6
doc: proofread of the all reST sources (no content change)
...
Normalize reST sources with best practice and KISS in mind.
to name a few points:
- simplify reST tables
- make use of ``literal`` markup for monospace rendering
- fix code-blocks for better rendering in HTML
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- drop useless indentation of lists
- ...
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 19:20:56 +01:00
Markus Heiser
0011890043
gh-pages - build docs & deploy on gh-pages branch
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 14:15:41 +01:00
Markus Heiser
5b14772b20
doc: installation.rst improve reST markup
...
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- place *WARNING* lines into a '.. warning::' admonition block
- make use of ``literal`` markup for monospace rendering
- drop useless indentation of lists
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 13:30:12 +01:00
Markus Heiser
0a7479f194
doc: [fix] WARNING: Could not lex literal_block as "json"
...
docs/admin/filtron.rst:24: \
WARNING: Could not lex literal_block as "json". Highlighting skipped.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 13:24:18 +01:00
Markus Heiser
af2cae6d1d
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx
...
- add sphinx extensions
- patch documentation to make use of
These modules help to simplify the reST markup of external references. BTW it
helps to write more readable reST and form custom brands.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 12:39:38 +01:00
Markus Heiser
25fa7da6c8
doc: use customized pocoo theme (pallets-sphinx-themes)
...
The old searx theme was a copy of the flask theme. In the meantime this theme
is available from the python module pallets-sphinx-themes.
This patch makes pallets-sphinx-themes as a (dev) requirement and drops most of
the old and obsolete searx theme settings/files.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 12:21:52 +01:00
Markus Heiser
ef85943e06
Makefile: add documentation build targets docs & docs-live
...
BTW:
- add build & dist folder to .gitignore
- justify indentation of build messages (makefile.python)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-12 12:10:32 +01:00