Markus Heiser
3cb7daedb7
docs: generic doocumentation for searx-uwsgi
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
f25da6070e
docs: generic documentation get templating
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c3e4753ce9
docs: generic documentation from the installation scripts
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
4d67164918
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
a9d184473f
docs: fix dead Searx-instance links to https://searx.space
...
Related to #1853 / BTW update year of copyright note
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
63b0ba701f
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
0bfc61dbe9
tooling box: misc fixes from lxc tests
...
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>
5 years ago
Dalf
88f9ac58f4
[mod] move public instance list to https://searx.space
5 years ago
Markus Heiser
ed4cb4f160
tooling box: varius fix from tests
5 years ago
Markus Heiser
a99c65dd01
docs: misc marginal fixes
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
2f40f61f83
/etc/filtron/rules.json: normalize rules from docs & tooling box
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d07119ca49
docs(css): render ..content and ..toctree directive same
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
eedd63ccd5
docs: revision of the installation instructions
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
a5eefea61d
docs: fix extlink 'origin' to use GIT_BRANCH env
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
9278f0fb45
docs: add some documentation about the tooling box ./utils/*
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
Markus Heiser
58a9fa93f6
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
5 years ago
Markus Heiser
fe64274fb0
docs: filtron.sh add remark about init systems
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Emilien Devos
e84067816b
searx.be stopped using Fathom analytics
5 years ago
Markus Heiser
39feb141bc
docs(admin): add description of the utils/filtron.sh script
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
Markus Heiser
51b9295b84
Merge branch 'master' of https://github.com/asciimoo/searx into add-docs
5 years ago
Robin Schneider
3e5a3ee4e4
Let Nginx deliver static files directory in all examples
5 years ago
Robin Schneider
088337295a
Simply Nginx example by using alias directive for subdirectory URL
...
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.
5 years ago
Robin Schneider
a1d9c81915
Fix Nginx subdir URL install docs which allowed download of settings.yml
...
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.
5 years ago
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>
5 years ago
Markus Heiser
f9be534b2a
docs(dev): fix minor markup typos
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
Markus Heiser
b91e07bbf1
docs(css): render HTML rst-example slightly more discreet
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d1892b2112
docs(admin): add article 'Buildhosts' with system requirements
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
Markus Heiser
c8645d6e37
doc: reST-primer -- imrpove desription of definition lists
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
Markus Heiser
5bdca1a5bf
doc: improved HTML table layout (CSS)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d1154202bc
doc: add reST templating // incl. generic engine tabe
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c2b9aa0c2f
docs: reST-primer describe table markup (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b201f84595
docs: reST-primer continued proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
ae7cb5937e
docs: reST-primer first proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b82f61f704
doc: reST primer -- describe admonitions & customize their CSS
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago