diff options
author | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-12 19:20:56 +0100 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-12 19:20:56 +0100 |
commit | e9fff4fde6d7a8bec3fae087d2afe1fce2145f22 (patch) | |
tree | 4714c7130b9b6ae90ef53084106b23b967b4150b /docs/blog/admin.rst | |
parent | 0011890043a65b318a32134ab4029f3c74bc07ee (diff) | |
download | searxng-e9fff4fde6d7a8bec3fae087d2afe1fce2145f22.tar.gz searxng-e9fff4fde6d7a8bec3fae087d2afe1fce2145f22.zip |
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>
Diffstat (limited to 'docs/blog/admin.rst')
-rw-r--r-- | docs/blog/admin.rst | 53 |
1 files changed, 27 insertions, 26 deletions
diff --git a/docs/blog/admin.rst b/docs/blog/admin.rst index 18d5ed33b..e95316192 100644 --- a/docs/blog/admin.rst +++ b/docs/blog/admin.rst @@ -1,42 +1,43 @@ -Searx admin interface: manage your instance from your browser +============================================================= +Searx admin interface ============================================================= -One of the biggest advantages of searx is being extremely customizable. But at first it can be daunting to newcomers. -A barrier of taking advantage of this feature is our ugly settings file which is sometimes hard to understand and edit. +.. _searx-admin: https://github.com/kvch/searx-admin#searx-admin +.. _NLnet Foundation: https://nlnet.nl/ -To make self-hosting searx more accessible a new tool is introduced, called ``searx-admin``. -It is a web application which is capable of managing your instance and manipulating its settings via a web UI. -It aims to replace editing of ``settings.yml`` for less experienced administrators or people -who prefer graphical admin interfaces. + manage your instance from your browser -.. figure:: searx-admin-engines.png - :scale: 50 % - :alt: Screenshot of engine list - :align: center - :figclass: align-center - - Configuration page of engines +.. sidebar:: Installation + Installation guide can be found in the repository of searx-admin_. -Since ``searx-admin`` acts as a supervisor for searx, we have decided to implement it -as a standalone tool instead of part of searx. Another reason for making it a standalone -tool is that the codebase and dependencies of searx should not grow because of a fully optional feature, -which does not affect existing instances. +One of the biggest advantages of searx is being extremely customizable. But at +first it can be daunting to newcomers. A barrier of taking advantage of this +feature is our ugly settings file which is sometimes hard to understand and +edit. +To make self-hosting searx more accessible a new tool is introduced, called +``searx-admin``. It is a web application which is capable of managing your +instance and manipulating its settings via a web UI. It aims to replace editing +of ``settings.yml`` for less experienced administrators or people who prefer +graphical admin interfaces. -Installation ------------- +.. figure:: searx-admin-engines.png + :alt: Screenshot of engine list -Installation guide can be found in the repository of searx-admin: -https://github.com/kvch/searx-admin#installation--usage + Configuration page of engines -Acknowledgements ----------------- +Since ``searx-admin`` acts as a supervisor for searx, we have decided to +implement it as a standalone tool instead of part of searx. Another reason for +making it a standalone tool is that the codebase and dependencies of searx +should not grow because of a fully optional feature, which does not affect +existing instances. -This development was sponsored by `NLnet Foundation`_. -.. _NLnet Foundation: https://nlnet.nl/ +Acknowledgements +================ +This development was sponsored by `NLnet Foundation`_. | Happy hacking. | kvch // 2017.08.22 21:25 |