diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 139 |
1 files changed, 37 insertions, 102 deletions
diff --git a/README.rst b/README.rst index 20c9175bb..15c136879 100644 --- a/README.rst +++ b/README.rst @@ -1,130 +1,65 @@ .. SPDX-License-Identifier: AGPL-3.0-or-later ----- +.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine +.. _Installation guide: https://docs.searxng.org/admin/installation.html +.. _Configuration guide: https://docs.searxng.org/admin/settings/index.html +.. _CONTRIBUTING: https://raw.githubusercontent.com/searxng/searxng/refs/heads/master/CONTRIBUTING.rst +.. _LICENSE: https://raw.githubusercontent.com/searxng/searxng/refs/heads/master/LICENSE .. figure:: https://raw.githubusercontent.com/searxng/searxng/master/client/simple/src/brand/searxng.svg - :target: https://docs.searxng.org/ + :target: https://searxng.org :alt: SearXNG - :width: 100% - :align: center - ----- - -Privacy-respecting, hackable `metasearch engine`_ - -Searx.space_ lists ready-to-use running instances. - -A user_, admin_ and developer_ handbook is available on the homepage_. - -|SearXNG install| -|SearXNG homepage| -|SearXNG wiki| -|AGPL License| -|Issues| -|commits| -|weblate| -|SearXNG logo| - ----- + :width: 512px -.. _searx.space: https://searx.space -.. _user: https://docs.searxng.org/user -.. _admin: https://docs.searxng.org/admin -.. _developer: https://docs.searxng.org/dev -.. _homepage: https://docs.searxng.org/ -.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine - -.. |SearXNG logo| image:: https://raw.githubusercontent.com/searxng/searxng/master/client/simple/src/brand/searxng-wordmark.svg - :target: https://docs.searxng.org/ - :width: 5% - -.. |SearXNG install| image:: https://img.shields.io/badge/-install-blue - :target: https://docs.searxng.org/admin/installation.html - -.. |SearXNG homepage| image:: https://img.shields.io/badge/-homepage-blue - :target: https://docs.searxng.org/ +| -.. |SearXNG wiki| image:: https://img.shields.io/badge/-wiki-blue - :target: https://github.com/searxng/searxng/wiki +SearXNG is a `metasearch engine`_. Users are neither tracked nor profiled. -.. |AGPL License| image:: https://img.shields.io/badge/license-AGPL-blue.svg - :target: https://github.com/searxng/searxng/blob/master/LICENSE +.. image:: https://img.shields.io/badge/organization-3050ff?style=flat-square&logo=searxng&logoColor=fff&cacheSeconds=86400 + :target: https://github.com/searxng + :alt: Organization -.. |Issues| image:: https://img.shields.io/github/issues/searxng/searxng?color=yellow&label=issues - :target: https://github.com/searxng/searxng/issues +.. image:: https://img.shields.io/badge/documentation-3050ff?style=flat-square&logo=readthedocs&logoColor=fff&cacheSeconds=86400 + :target: https://docs.searxng.org + :alt: Documentation -.. |PR| image:: https://img.shields.io/github/issues-pr-raw/searxng/searxng?color=yellow&label=PR - :target: https://github.com/searxng/searxng/pulls +.. image:: https://img.shields.io/github/license/searxng/searxng?style=flat-square&label=license&color=3050ff&cacheSeconds=86400 + :target: https://raw.githubusercontent.com/searxng/searxng/refs/heads/master/LICENSE + :alt: License -.. |commits| image:: https://img.shields.io/github/commit-activity/y/searxng/searxng?color=yellow&label=commits - :target: https://github.com/searxng/searxng/commits/master +.. image:: https://img.shields.io/github/commit-activity/y/searxng/searxng/master?style=flat-square&label=commits&color=3050ff&cacheSeconds=3600 + :target: https://github.com/searxng/searxng/commits/master/ + :alt: Commits -.. |weblate| image:: https://translate.codeberg.org/widgets/searxng/-/searxng/svg-badge.svg +.. image:: https://img.shields.io/weblate/progress/searxng?server=https%3A%2F%2Ftranslate.codeberg.org&style=flat-square&label=translated&color=3050ff&cacheSeconds=86400 :target: https://translate.codeberg.org/projects/searxng/ - - -Contact -======= - -Ask questions or chat with the SearXNG community (this not a chatbot) on - -IRC - `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_ - which is bridged to Matrix. - -Matrix - `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_ - + :alt: Translated Setup ===== -- A well maintained `Docker image`_, also built for ARM64 and ARM/v7 - architectures. -- Alternatively there are *up to date* `installation scripts`_. -- For individual setup consult our detailed `Step by step`_ instructions. -- To fine-tune your instance, take a look at the `Administrator documentation`_. +To install SearXNG, see `Installation guide`_. -.. _Administrator documentation: https://docs.searxng.org/admin/index.html -.. _Step by step: https://docs.searxng.org/admin/installation-searxng.html -.. _installation scripts: https://docs.searxng.org/admin/installation-scripts.html -.. _Docker image: https://github.com/searxng/searxng-docker +To fine-tune SearXNG, see `Configuration guide`_. -Translations -============ +Further information on *how-to* can be found `here <https://docs.searxng.org/admin/index.html>`_. -.. _Weblate: https://translate.codeberg.org/projects/searxng/searxng/ +Connect +======= -Help translate SearXNG at `Weblate`_ - -.. figure:: https://translate.codeberg.org/widgets/searxng/-/multi-auto.svg - :target: https://translate.codeberg.org/projects/searxng/ +If you have questions or want to connect with others in the community, +we have two official channels: +- `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_ +- `#searxng @ libera.chat <https://web.libera.chat/?channel=#searxng>`_ (bridged to Matrix) Contributing ============ -.. _development quickstart: https://docs.searxng.org/dev/quickstart.html -.. _developer documentation: https://docs.searxng.org/dev/index.html - -Are you a developer? Have a look at our `development quickstart`_ guide, it's -very easy to contribute. Additionally we have a `developer documentation`_. - +See `CONTRIBUTING`_ for more details. -Codespaces -========== - -You can contribute from your browser using `GitHub Codespaces`_: - -- Fork the repository -- Click on the ``<> Code`` green button -- Click on the ``Codespaces`` tab instead of ``Local`` -- Click on ``Create codespace on master`` -- VSCode is going to start in the browser -- Wait for ``git pull && make install`` to appear and then disappear -- You have `120 hours per month`_ (see also your `list of existing Codespaces`_) -- You can start SearXNG using ``make run`` in the terminal or by pressing ``Ctrl+Shift+B`` +License +======= -.. _GitHub Codespaces: https://docs.github.com/en/codespaces/overview -.. _120 hours per month: https://github.com/settings/billing -.. _list of existing Codespaces: https://github.com/codespaces +This project is licensed under the GNU Affero General Public License (AGPL-3.0). +See `LICENSE`_ for more details. |