summaryrefslogtreecommitdiff
path: root/docs/admin
AgeCommit message (Collapse)Author
2020-05-31add display_error_messages option to engine settingsNoémi Ványi
A new option is added to engines to hide error messages from users. It is called `display_error_messages` and by default it is set to `True`. If it is set to `False` error messages do not show up on the UI. Keep in mind that engines are still suspended if needed regardless of this setting. Closes #1828
2020-05-19Revise outdated URLsSion Kazama
2020-04-28[docs] installation: add note to update OS before install searxMarkus Heiser
see: https://github.com/asciimoo/searx/pull/1803#issuecomment-618456661 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-13doc: add missing command lines to nginx docsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-11nginx: normalize installation (docs and script)s over all distrosMarkus Heiser
This is the revision of the documentation about the varous nginx installation variants. It also implements the nginx installation scripts for morty and filtron. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-09docs: proofreading of all the installation topicsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-07apache: normalize installation (docs and script)s over all distrosMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-06docs: rework of chapter "Install with apache"Markus Heiser
BTW: normalize installation-nginx.rst
2020-04-04docs: remove PR #1803 hintsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-03utils/filtron.sh: add generic documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-31docs: use make and uitls/searx.sh in containersMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-09searx.sh: add buildhost cmd, installs OS packages for buildsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-06fix: minor typosMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-06docs: for example URLs use iana's example.orgMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-06docs: improve description of uwsgi & ngingx setupMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-04docs: describe uwsgi setup of all suported distributionsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-04docs: complement uwsgi documentation for all distrosMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-03docs: generic doocumentation for searx-uwsgiMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-02docs: generic documentation from the installation scriptsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-16tooling box: misc fixes from lxc testsMarkus Heiser
Tested by: sudo -H ./utils/lxc.sh build containers sudo -H ./utils/lxc.sh cmd /share/searx/utils/searx.sh install all sudo -H ./utils/lxc.sh cmd /share/searx/utils/filtron.sh install all sudo -H ./utils/lxc.sh cmd /share/searx/utils/morty.sh install all Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-08tooling box: varius fix from testsMarkus Heiser
2020-02-04/etc/filtron/rules.json: normalize rules from docs & tooling boxMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04docs: revision of the installation instructionsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04docs: add some documentation about the tooling box ./utils/*Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-03doc: add descriptions of our tooling box in ./utilsMarkus Heiser
Initial started with the scripts for searx, filtron and morty installations. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-12docs: filtron.sh add remark about init systemsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-11docs(admin): add description of the utils/filtron.sh scriptMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-08build requirements: add a shell script static analysis toolMarkus Heiser
ShellCheck: https://github.com/koalaman/shellcheck Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-03Merge branch 'master' of https://github.com/asciimoo/searx into add-docsMarkus Heiser
2019-12-31Let Nginx deliver static files directory in all examplesRobin Schneider
2019-12-31Simply Nginx example by using alias directive for subdirectory URLRobin Schneider
We explicitly specific the static directory here using alias to allow to host from a other subdirectory than "searx" which just so happens to match the source code directory.
2019-12-31Fix Nginx subdir URL install docs which allowed download of settings.ymlRobin Schneider
Closes: #1617 There is an issue with the setup example in https://asciimoo.github.io/searx/dev/install/installation.html#installation for subdirectory URL deployments: ```nginx root /usr/local/searx; location = /searx { rewrite ^ /searx/; } try_files $uri @searx; } location @searx { uwsgi_param SCRIPT_NAME /searx; include uwsgi_params; uwsgi_modifier1 30; uwsgi_pass unix:/run/uwsgi/app/searx/socket; } ``` `try_files` causes Nginx to search for files in the server root first. If it matches a file, it is returned. Only if no file matched, the request is passed to uwsgi. The worst consequence I can think of is that `settings.yml` can be downloaded without authentication (where secrets and configuration details are stored). To fix this, I propose: ```nginx location = /searx { rewrite ^ /searx/; } location /searx/static { } location /searx { uwsgi_param SCRIPT_NAME /searx; include uwsgi_params; uwsgi_pass unix:/run/uwsgi/app/searx/socket; } ``` And add ``` route-run = fixpathinfo: ``` to `/etc/uwsgi/apps-available/searx.ini` because `uwsgi_modifier1 30` is apparently deprecated. Ref: https://uwsgi-docs.readthedocs.io/en/latest/Changelog-2.0.11.html#fixpathinfo-routing-action I assume this issue exists because some uwsgi upstream docs also use the `try_files` construct (at least I have seen this somewhere in the docs or somewhere else on the Internet but cannot find it right now again). https://uwsgi-docs.readthedocs.io/en/latest/Nginx.html#hosting-multiple-apps-in-the-same-process-aka-managing-script-name-and-path-info also warns about this: > If used incorrectly a configuration like this may cause security problems. For your sanity’s sake, double-triple-quadruple check that your application files, configuration files and any other sensitive files are outside of the root of the static files.
2019-12-30docs(admin): moved settings description from wiki to docsMarkus Heiser
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-30docs(admin): add weight & disabled cols to engine tableMarkus Heiser
BTW: remove internal suspend_end_time Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-28docs(admin): add article 'Buildhosts' with system requirementsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add plugin section to admin section (template)Markus Heiser
- Plugins configured at built time (defaults) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add 'Architecture' article to admin sectionMarkus Heiser
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-21doc: add reST templating // incl. generic engine tabeMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: moved reST sources in the right folder (much clearer)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: proofread of the all reST sources (no content change)Markus Heiser
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-12doc: [fix] WARNING: Could not lex literal_block as "json"Markus Heiser
docs/admin/filtron.rst:24: \ WARNING: Could not lex literal_block as "json". Highlighting skipped. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2017-08-08[enh] add morty documentationAdam Tauber
2016-10-30add sample config of filtronNoémi Ványi
2016-09-06add embedded search to docsNoémi Ványi
2016-07-09better API docs && more features in listNoemi Vanyi