mirror of
https://github.com/searxng/searxng.git
synced 2025-09-03 20:13:50 +00:00
SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled.
A local development server can be launched by one of these command lines:: $ flask --app searx.webapp run $ python -m searx.webapp The different ways of starting the server should lead to the same result, which is generally the case. However, if the modules are reloaded after code changes (reload option), it must be avoided that the application is initialized twice at startup. We have already discussed this in 2022 [1][2]. Further information on this topic can be found in [3][4][5]. To test a bash in the ./local environment was started and the follwing commands had been executed:: $ ./manage pyenv.cmd bash --norc --noprofile (py3) SEARXNG_DEBUG=1 flask --app searx.webapp run --reload (py3) SEARXNG_DEBUG=1 python -m searx.webapp Since the generic parts of the docs also initialize the app to generate doc from it, the build of the docs was also tested:: $ make docs.clean docs.live [1] https://github.com/searxng/searxng/pull/1656#issuecomment-1214198941 [2] https://github.com/searxng/searxng/pull/1616#issuecomment-1206137468 [3] https://flask.palletsprojects.com/en/stable/api/#flask.Flask.run [4] https://github.com/pallets/flask/issues/5307#issuecomment-1774646119 [5] https://stackoverflow.com/a/25504196 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> |
||
---|---|---|
.devcontainer | ||
.github | ||
.vscode | ||
client/simple | ||
dockerfiles | ||
docs | ||
searx | ||
searxng_extra | ||
tests | ||
utils | ||
.coveragerc | ||
.dir-locals-template.el | ||
.dockerignore | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.pylintrc | ||
.tool-versions | ||
.weblate | ||
.yamllint.yml | ||
AUTHORS.rst | ||
babel.cfg | ||
CHANGELOG.rst | ||
CONTRIBUTING.md | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
manage | ||
package.json | ||
PULL_REQUEST_TEMPLATE.md | ||
pyrightconfig-ci.json | ||
pyrightconfig.json | ||
README.rst | ||
requirements-dev.txt | ||
requirements.txt | ||
SECURITY.md | ||
setup.py |
Privacy-respecting, hackable metasearch engine
Searx.space lists ready-to-use running instances.
A user, admin and developer handbook is available on the homepage.
Contact
Ask questions or chat with the SearXNG community (this not a chatbot) on
- IRC
#searxng on libera.chat which is bridged to Matrix.
- Matrix
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.
Translations
Help translate SearXNG at Weblate
Contributing
Are you a developer? Have a look at our development quickstart guide, it's very easy to contribute. Additionally we have a developer documentation.
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 ofLocal
- 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 pressingCtrl+Shift+B