kamp/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-11-16 17:40:11 +01:00
Code
7,347 Commits 6 Branches 17 Tags 132 MiB
b7b184244d
Commit Graph

447 Commits

Author SHA1 Message Date
Markus Heiser
0616684baa [fix] sphinx 3.1 CSS issues 
See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS:

- https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605
- https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 19:02:22 +02:00
Markus Heiser
a5e82f9801 [fix] margial typo in docs/user/onf.py doc-string 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:57:10 +02:00
Markus Heiser
bfef2c3b65 [fix] buildprocess of docs in LXC (containers) 
The $DOCS_BUILD variable (like all BUILD variables) in the lxc environment::

   sudo -H ./utils/lxc.sh cmd searx-archlinux make docs

is different from running build process in the HOST::

   make docs

with kernel-include directive we can use the environment variables in the reST
documents to address the correct file location of the include.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:52:45 +02:00
Markus Heiser
aa5f947157 [enh] add 'kernel-include' reST-directive 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:51:31 +02:00
Markus Heiser
4f7a6c09dd [fix] buildhosts documentation 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:39:56 +02:00
Markus Heiser
6ff20cef73 [fix] indentation of filtron's rules (json) 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:31:46 +02:00
Markus Heiser
6fc26775e4 Merge branch 'master' of https://github.com/asciimoo/searx into filtron 2020-06-01 09:25:30 +02:00
Noémi Ványi
e3282748d0 add display_error_messages option to engine settings 
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-31 19:17:48 +02:00
Markus Heiser
f576cadfba [fix] installation instructions: pip install -e searx (setup.py) 
In the past we did not really install searx into the virtualenv.  This is a
problem, since entry-points and other python installation stuff is not trigger.

See discussion: https://github.com/asciimoo/searx/pull/1938#issuecomment-632056508

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-05-21 15:46:43 +02:00
Sion Kazama
74e6f5d724 Revise outdated URLs 2020-05-19 20:47:35 +08:00
Markus Heiser
26a3a7d523 [docs] installation: add note to update OS before install searx 
see: https://github.com/asciimoo/searx/pull/1803#issuecomment-618456661

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-28 14:44:28 +02:00
Markus Heiser
5fc17de861 docs: marginal fix of command's './utils/lxc.sh show suite' output 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-19 12:34:37 +02:00
Markus Heiser
30c0a0fb64 doc: add missing command lines to nginx docs 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-13 13:00:03 +02:00
Markus Heiser
58d5da8b57 nginx: normalize installation (docs and script)s over all distros 
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-11 13:19:11 +02:00
Markus Heiser
ebde9d10fd docs: proofreading of all the installation topics 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-09 15:04:23 +02:00
Markus Heiser
f693149cde Changes from the installation tests on (all) LXC containers. 
Tested and fixed HTTP & uWSGI installation on:

  ubu1604 ubu1804 ubu1910 ubu2004 fedora31 archlinux

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-08 18:38:36 +02:00
Markus Heiser
ee39a098ac apache: normalize installation (docs and script)s over all distros 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-07 18:31:51 +02:00
Markus Heiser
eb0d4646d8 docs: rework of chapter "Install with apache" 
BTW: normalize installation-nginx.rst
 2020-04-06 17:59:06 +02:00
Markus Heiser
84daf9999c docs: remove PR #1803 hints 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-04 08:36:48 +02:00
Markus Heiser
e32b08f616 utils/morty.sh: add generic documentation 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-03 20:26:20 +02:00
Markus Heiser
853be4e11c utils/filtron.sh: add generic documentation 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-03 20:24:40 +02:00
Markus Heiser
af988dbf71 utils/lxc.sh: support build of selected containers 
$ sudo -H ./utils/lxc.sh build  <name>
  $ sudo -H ./utils/lxc.sh show   [images|suite|info|config [<name>]]

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-04-03 17:08:42 +02:00
Markus Heiser
f27f6c6c5d docs: use make and uitls/searx.sh in containers 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-31 18:25:40 +02:00
Markus Heiser
dd53c45a2c docs: add utils/lxc.sh docs, normalize filtron, morty & searx docs 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-30 18:47:01 +02:00
Markus Heiser
4e307edb2d docs: document Makefile setup and 'buildenv' (aka brand) 
Add documentation of the Makefile environment (aka brand, buildenv), introduced
in PR #1900.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-30 13:31:13 +02:00
Markus Heiser
0742c2504d build environment: add GIT_BRANCH variable 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-29 16:28:17 +02:00
Markus Heiser
7b4cf2eb48 tooling box: simplify build enviroments 
- no more need for a .config.mk
- docs: use searx.brands environment
- searx.sh, filtron.sh & morty.sh are sourcing utils/brand.env

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-29 15:09:34 +02:00
Markus Heiser
65b22be1f4 Merge PR #1900 of https://github.com/asciimoo/searx into filtron 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-29 13:03:27 +02:00
Markus Heiser
d471ec86dd Makefile: add target node.env - download & install npm dependencies 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-25 16:38:52 +01:00
Markus Heiser
757ebb5d9f [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>
 2020-03-25 14:09:47 +01:00
Markus Heiser
e84fc94300 [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>
 2020-03-25 11:51:03 +01:00
Markus Heiser
2d956696e9 docs: building (PDF) books / build user book 
BTW: cleaned up Makefile target help

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-21 18:45:38 +01:00
Markus Heiser
80f7b65804 searx.sh: add buildhost cmd, installs OS packages for builds 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-09 01:37:26 +01:00
Markus Heiser
04ad648105 makefile.python: remove python2 support 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-08 18:35:38 +01:00
Markus Heiser
a258358633 Merge branch 'master' of https://github.com/asciimoo/searx into filtron 2020-03-07 09:03:24 +01:00
Markus Heiser
c15337850e fix: minor typos 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-06 22:06:19 +01:00
Markus Heiser
857a1458b1 docs: for example URLs use iana's example.org 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-06 15:04:12 +01:00
Markus Heiser
387c6a7769 docs: improve description of uwsgi & ngingx setup 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-06 14:47:00 +01:00
Noémi Ványi
3d03fb3050 Add new post to blog about private engines 2020-03-05 22:21:20 +01:00
Markus Heiser
cbc08fdc26 docs: describe uwsgi setup of all suported distributions 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-04 19:56:40 +01:00
Markus Heiser
3aff2c19d1 docs: complement uwsgi documentation for all distros 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-04 12:22:20 +01:00
Markus Heiser
3cb7daedb7 docs: generic doocumentation for searx-uwsgi 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-03 19:57:15 +01:00
Markus Heiser
f25da6070e docs: generic documentation get templating 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-03 16:26:02 +01:00
Markus Heiser
c3e4753ce9 docs: generic documentation from the installation scripts 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-03-02 19:00:19 +01:00
Markus Heiser
4d67164918 Merge branch 'master' of https://github.com/asciimoo/searx into filtron 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-23 13:50:22 +01:00
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>
 2020-02-20 18:11:34 +01:00
Markus Heiser
63b0ba701f Merge branch 'master' of https://github.com/asciimoo/searx into filtron 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-17 15:00:58 +01:00
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>
 2020-02-16 22:29:06 +01:00
Dalf
88f9ac58f4 [mod] move public instance list to https://searx.space 2020-02-14 13:48:44 +01:00
Markus Heiser
ed4cb4f160 tooling box: varius fix from tests 2020-02-08 13:24:08 +01:00
Markus Heiser
a99c65dd01 docs: misc marginal fixes 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-05 07:37:26 +01:00
Markus Heiser
2f40f61f83 /etc/filtron/rules.json: normalize rules from docs & tooling box 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-04 17:59:58 +01:00
Markus Heiser
d07119ca49 docs(css): render ..content and ..toctree directive same 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-04 16:43:07 +01:00
Markus Heiser
eedd63ccd5 docs: revision of the installation instructions 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-04 16:42:13 +01:00
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
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
58a9fa93f6 Merge branch 'master' of https://github.com/asciimoo/searx into filtron 2020-01-13 18:40:09 +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
Emilien Devos
e84067816b
searx.be stopped using Fathom analytics 2020-01-12 10:48:29 +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
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
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
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
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
Robin Schneider
3e5a3ee4e4
Let Nginx deliver static files directory in all examples 2019-12-31 14:43:14 +01:00
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.
 2019-12-31 14:41:27 +01:00
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.
 2019-12-31 14:24:27 +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
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
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
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
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
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
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
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
Noémi Ványi
021e1da4c9 add post about introducing offline engines 2019-10-23 13:06:19 +02:00
pofilo
c1ccb25d56 Merge pull request #1389 from bourrel/patch-1 
Update quickstart.rst
 2018-11-29 15:54:56 +01:00
tmikaeld
77494166d2 Formatting... 2018-10-21 11:42:00 +02:00
tmikaeld
10ebe8cec9 Added missing symlink instruction 2018-10-21 11:36:11 +02:00
Léo Bourrel
94af140318 Update quickstart.rst 
Rename `build_grunt` to `grunt_build` as in manage.sh
 2018-08-30 11:14:03 +02:00
Noémi Ványi
20e85275cb remove Gratipay and Flattr from sidebar 2018-01-23 20:43:22 +01:00
Noémi Ványi
2134c7c693 change python-pybabel to python-babel in package requirements 
Closes #1147
 2018-01-17 22:05:10 +01:00
Noémi Ványi
07ef4a3e4a update search api with params and description on syntax 2017-10-23 18:06:49 +02:00
Noémi Ványi
979dd3d96c blog: add post about searx-admin 2017-08-22 21:30:00 +02:00
Adam Tauber
6cc9f56949 [enh] add morty documentation 2017-08-08 15:23:17 +02:00
Noémi Ványi
74d8ed284d add format param to search api 2017-07-09 22:02:29 +02:00
Adam Tauber
b92631bf8c various mods: uwsgi setup and version update ++ py3 img src fix ++ new sphinx version - closes #939 2017-06-12 12:37:07 +02:00
Noémi Ványi
93e6258463 add first blog entry on python3 support 2017-05-13 22:16:23 +02:00
James Coleman
b8f5c75374 Corrected spelling of ads in user/own-instance.html 2017-04-19 15:29:32 -05:00
Noémi Ványi
1bd51c6de2 rewrite Translation page 2017-03-18 23:57:19 +01:00
Noémi Ványi
e43e5af207 bump searx version to 0.11.0 2017-03-18 23:55:20 +01:00
Noémi Ványi
6ecd8e3bd7 installation: nginx mod to sites-enabled 2016-11-20 21:13:37 +01:00
Noémi Ványi
d0d2d18a4d fix typos in own instance page 2016-11-05 16:28:32 +01:00
Noémi Ványi
50f25193c1 engine overview fix torrent table 2016-11-05 16:25:51 +01:00
Noémi Ványi
f55eea083f generated files of parent 2016-11-05 15:57:37 +01:00
Noémi Ványi
31ea4280bf "why use a personal instance?" page 2016-11-05 15:57:37 +01:00
Noémi Ványi
ee18ad780e conf: bump searx version to 0.10.0 2016-11-04 21:53:11 +01:00
Noémi Ványi
c2cf46092e docs: fix typos based on #653 2016-11-04 18:38:07 +01:00
Noémi Ványi
dca4d276a4 add sample config of filtron 2016-10-30 01:01:22 +02:00
Noemi Vanyi
daf736f1dd add possible values of time_range param 2016-09-10 15:12:11 +02:00
Noémi Ványi
013139b036 add embedded search to docs 2016-09-06 18:16:29 +02:00
Noémi Ványi
6d99db7af3 add new search parameter time_range 2016-09-06 18:13:20 +02:00
Noemi Vanyi
9e135f9fab simplify index page 2016-07-15 18:41:05 +02:00
Noemi Vanyi
521f398709 disable breaking "searx" into multiple lines 2016-07-09 23:01:00 +02:00
Noemi Vanyi
2ad8715b32 better API docs && more features in list 2016-07-09 22:31:21 +02:00
Noemi Vanyi
ffcceed517 version bump to 0.9.0 && year to 2016 2016-07-09 21:46:20 +02:00
Noemi Vanyi
b40d7a2b36 add reverse proxy configuration 2016-04-21 14:30:17 +02:00
Noemi Vanyi
2430baa1fd update install docs on reverse proxy 2016-04-21 13:16:18 +02:00
Noemi Vanyi
9c56154cfe add dev tips to quickstart 2016-04-21 13:15:04 +02:00
Noemi Vanyi
016ab5c1e8 add development quickstart 2016-02-01 21:28:13 +01:00
Thomas Pointhuber
cf9bd14a7d [fix] little typo 2016-01-21 16:30:42 +01:00
Thomas Pointhuber
fb62d01194 [enh] improve translation documentation 2016-01-21 16:25:40 +01:00
Noemi Vanyi
08d26609a5 update & fix install guide after install refactor 2016-01-10 20:10:53 +01:00
Noemi Vanyi
3b06814192 [doc] rewrite contribution guide 2015-12-10 21:40:22 +01:00
Noemi Vanyi
240802003e [doc] fix small mistakes in engine overview 2015-12-10 21:38:39 +01:00
Noemi Vanyi
ae69a58089 [doc] grammar & format fixes in engine overview 2015-12-01 15:32:06 +01:00
Adam Tauber
11d6d80d88 [doc] engines overview added 2015-11-28 19:26:45 +01:00
Adam Tauber
1d6597b407 [enh] initial structure 2015-11-17 23:38:22 +01:00