zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 18:24:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled.
5,637 Commits 5 Branches 17 Tags 71 MiB
Python 73.9%
Shell 10.6%
HTML 6.2%
Less 5.1%
JavaScript 2.8%
Other 1.3%
05149db4c1
Go to file
Martin Fischer 05149db4c1 [help] render user documentation once on startup 
Currently we have two kinds of user documentation:

* the about page[1] which is written in HTML and part of the web
  application and can therefore link instance-specific pages
  (like e.g. the preferences) via Jinja variables

* the Sphinx documentation[2] which is written in reStructuredText
  and cannot link instance-specific pages since it doesn't know
  which instance the user is using

The plan is to integrate the user documentation currently in Sphinx
into the application, so that it can also link instance specific pages.
We also want to enable the user documentation to be translated.

This commit implements the first step in this endeavor (see #722).

[1]: searx/templates/__common__/about.html
[2]: docs/user/ (currently served at https://docs.searxng.org/user/)
2022-01-23 08:01:55 +01:00
.github [mod] GitHub workflow: use cache 2022-01-05 20:59:59 +01:00
dockerfiles [mod] adjust dockerfiles/uwsgi.ini 2022-01-05 21:06:25 +01:00
docs [docs] fix some warnings from Sphinx-doc update 4.3.2 to 4.4.0 2022-01-21 09:35:00 +01:00
examples Fix whitespaces 2016-07-11 18:52:37 +07:00
searx [help] render user documentation once on startup 2022-01-23 08:01:55 +01:00
searxng_extra [fix] external bangs: don't overwrite Bangs in data trie 2022-01-12 19:37:13 +01:00
src/brand [simple] ImageLayout.watch: img_load_error.svg if img load fails 2021-11-29 21:10:13 +01:00
tests [typing] add results.Timing 2022-01-17 11:42:48 +01:00
utils Merge pull request #686 from return42/lib_redis 2022-01-11 19:55:14 +01:00
.config.sh reference docs.searxng.org 2022-01-02 21:18:29 +01:00
.coveragerc [mod] use github actions instead of travis 2020-11-17 15:09:06 +01:00
.dir-locals.el [emacs] .dir-locals.el: in json-mode use indentation of 4 2021-12-14 06:50:26 +01:00
.dockerignore [fix] tidy up ignore lists .gitignore & .dockerignore 2021-06-22 16:55:30 +02:00
.gitattributes [fix] update .gitattributes 2021-06-22 20:34:39 +02:00
.gitignore [mod] Tools to install and maintain NVM versions manager for Node.js 2021-11-16 23:31:11 +01:00
.nvm_packages [mod] NVM: dev-tools pre-installed in NVM's node installation 2021-11-20 17:08:22 +01:00
.nvmrc [mod] NVM: pin Node.js to v16.13.0 2021-11-20 15:19:17 +01:00
.pylintrc [pylint] disable consider-using-f-string in .pylintrc 2021-09-17 09:22:11 +02:00
.weblate [translations] web integration 2021-08-07 15:06:06 +02:00
.yamllint.yml [enh] add test.yamllint - lint yaml files 2021-06-05 17:41:24 +02:00
AUTHORS.rst [mod] engines - add IMDB / Internet Movie Database 2021-10-03 11:44:25 +02:00
babel.cfg babel.cfg: ignore node_modules directories 2021-08-02 09:44:13 +02:00
CHANGELOG.rst reference docs.searxng.org 2022-01-02 21:18:29 +01:00
CONTRIBUTING.md reference docs.searxng.org 2022-01-02 21:18:29 +01:00
Dockerfile [mod] Dockerfile: use binary from pypi 2021-12-18 14:07:29 +01:00
LICENSE [fix] full AGPLv3+ license according to #382 2015-07-04 18:23:54 +02:00
Makefile [mod] CI target test.rst: test reST markup of README.rst 2022-01-17 09:35:42 +01:00
manage [fix] issue reported by: make test.shell 2022-01-18 12:27:42 +01:00
PULL_REQUEST_TEMPLATE.md Add PR template and contribution guidelines 2020-07-10 17:10:02 +02:00
README.rst [mod] update README.rst / differences to searx 2022-01-17 09:34:42 +01:00
requirements-dev.txt Bump sphinx from 4.3.2 to 4.4.0 2022-01-21 07:04:53 +00:00
requirements.txt Revert "[hotfix] interim fix to get docker-build of CI without issues" 2022-01-17 18:03:29 +01:00
setup.py reference docs.searxng.org 2022-01-02 21:18:29 +01:00

README.rst

Privacy-respecting, hackable metasearch engine

If you are looking for running instances, ready to use, then visit searx.space. Otherwise jump to the user, admin and developer handbooks you will find on our homepage.

SearXNG install SearXNG homepage SearXNG wiki AGPL License Issues commits weblate SearXNG logo

Contact

Come join us if you have questions or just want to chat about SearXNG.

Matrix

#searxng:matrix.org

IRC

#searxng on libera.chat which is bridged to Matrix.

Differences to searx

SearXNG is a fork of searx. Here are some of the changes:

User experience

  • Huge update of the simple theme:
    • usable on desktop, tablet and mobile
    • light and dark versions (you can choose in the preferences)
    • support right-to-left languages
  • the translations are up to date, you can contribute on Weblate
  • the preferences page has been updated:
    • you can see which engines are reliable or not
    • engines are grouped inside each tab
    • each engine has a description
  • it is easier to report a bug of an engine
  • but you can also disable the recording of the metrics on the server

Setup

  • the Docker image is now also built for ARM64 and ARM/v7 architectures
  • you don't need Morty to proxy the images even on a public instance
  • on the way to embed Filtron into SearXNG
  • up to date installation scripts

Contributing is easier

  • readable debug log
  • contributions to the themes are made easier, check out our Development Quickstart guide
  • a lot of code cleanup and bug fixes
  • the dependencies are up to date

Translations

We need translators, suggestions are welcome at https://weblate.bubu1.eu/projects/searxng/searxng/