summaryrefslogtreecommitdiff
path: root/docs
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-03-25Makefile: add target node.env - download & install npm dependenciesMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-25[fix] brands: add variables from build env to grunt processMarkus Heiser
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>
2020-03-25[fix] brands: add variables from build env to sphinx-docMarkus Heiser
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>
2020-03-05Add new post to blog about private enginesNoémi Ványi
2020-02-20docs: fix dead Searx-instance links to https://searx.spaceMarkus Heiser
Related to #1853 / BTW update year of copyright note Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-14[mod] move public instance list to https://searx.spaceDalf
2020-01-12searx.be stopped using Fathom analyticsEmilien Devos
2020-01-06docs: move wiki/Searx-instances from wiki to docsMarkus Heiser
fix project link in conf.py Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-06docs(user): move wiki/Searx-instances from wiki to docsMarkus Heiser
fixed some reST markups Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-05docs(user): public instances, fix Searxes@Danwin entryMarkus Heiser
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-04docs(user): move wiki/Searx-instances from wiki to docs (WIP)Markus Heiser
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-04docs(user): move wiki/Searx-instances from wiki to docsMarkus Heiser
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-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(dev): fix minor markup typosMarkus Heiser
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(css): render HTML rst-example slightly more discreetMarkus Heiser
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-28docs(dev): add more markups to reST primerMarkus Heiser
- Literal blocks - Unicode substitution - Horizontal list - Math equations Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-26doc(dev): reST/sphinx add tabbed views extension (sphinx_tabs.tabs)Markus Heiser
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-25docs(dev): add refs to to gitmoji and Semantic PR in contrib sectionMarkus Heiser
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-24doc(dev): add remarks about creating good commits (messages)Markus Heiser
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-23doc: reST-primer -- imrpove desription of definition listsMarkus 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: CSS - fix alignment of code block in figure blocksMarkus Heiser
BTW: minor profread of reST.rst 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-22doc: improved HTML table layout (CSS)Markus Heiser
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-20docs: reST-primer describe table markup (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20docs: reST-primer continued proofreading (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20docs: reST-primer first proofreading (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20doc: reST primer -- describe admonitions & customize their CSSMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19doc: add content to reST primer (WIP) // linuxdocMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19doc: add reST primer (inital / WIP)Markus Heiser
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-18edoc: -- makefile.rst fix typo and add extlinks['man']Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-18doc: describe Makefile targetsMarkus Heiser
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-13doc: add note about docs-clean targetMarkus Heiser
BTW: fix some typos Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13doc: theme - make sidebar less eye-catchingMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13doc: document the new reST & gh-pages workflowMarkus 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: installation.rst improve reST markupMarkus Heiser
- 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-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>
2019-12-12doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinxMarkus Heiser
- 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-12doc: use customized pocoo theme (pallets-sphinx-themes)Markus Heiser
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>
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-06 16:48:22 +0000