A simple way to run SearXNG locally
Project description
SimpleXNG
SimpleXNG is a simplified package of SearXNG to make it a single command to run for local use.
Why?
The official install options for SearXNG are a bit complex and assume admin privileges to set up. This can be simplified a lot if you're just wanting to run it locally for your own use.
SimpleXNG is a tiny package to run SearXNG locally on macOS, Linux, or Windows.
I wrote this since a friend was asking me why it wasn't easier to set up for "localhost" use or embedded use. I thought I'd see if it worked as a minimal, modern uv package.
Running
-
Install uv if you haven't already.
-
Install:
uv tool install --upgrade simplexng
-
Run it:
simplexng --open
See more options:
simplexng --help
Notes
-
SimpleXNG uses uv to manage the Python dependencies.
-
It omits Apache, Nginx, and Docker setup.
-
It by default uses the minimal template settings with Redis and rate limiting turned off. (You can adjust the settings file if desired.)
-
Since SearXNG is distributed in Docker images only, we vendor a recent copy of SearXNG so it is all available in a single package from PyPI for quick installation.
-
On first run, it sets up a minimal config file (on macOS and Linux it will be
~/.config/simplexng/settings.yml), which you can edit and will be used on subsequent runs. -
You can see the version of SearXNG being used with
simplexng --version. If you want a newer or different build, you can clone this repo and run:./scripts/clone_searxng.sh HEAD # Or pick a revision uv run simplexng
-
Note this code and SearXNG are AGPL-3.0 licensed.
Project Docs
For how to install uv and Python, see installation.md.
For development workflows, see development.md.
For instructions on publishing to PyPI, see publishing.md.
This project was built from simple-modern-uv.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file simplexng-0.1.2.tar.gz.
File metadata
- Download URL: simplexng-0.1.2.tar.gz
- Upload date:
- Size: 4.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47a7de2dd0cbbc50e8c6b16c8e6aa6238d120105c35f9d59a1147bbbc7e61d63
|
|
| MD5 |
c91df187bc2199e0fda9ecc84ef4b34c
|
|
| BLAKE2b-256 |
7e35fcf8016cadc6099c1ae1250aea1fc5fb9eafc6786596fb06717acb2bd4a5
|
Provenance
The following attestation bundles were made for simplexng-0.1.2.tar.gz:
Publisher:
publish.yml on jlevy/simplexng
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
simplexng-0.1.2.tar.gz -
Subject digest:
47a7de2dd0cbbc50e8c6b16c8e6aa6238d120105c35f9d59a1147bbbc7e61d63 - Sigstore transparency entry: 223427946
- Sigstore integration time:
-
Permalink:
jlevy/simplexng@c0149f3d48c0ba946b7cf155df5b167ad25a53c5 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/jlevy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c0149f3d48c0ba946b7cf155df5b167ad25a53c5 -
Trigger Event:
release
-
Statement type:
File details
Details for the file simplexng-0.1.2-py3-none-any.whl.
File metadata
- Download URL: simplexng-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8802bc2649dfd6b89058f932055de477ecc7e12161ba57bb41b3772a6430a03
|
|
| MD5 |
2c1e5c043932d74a703ea8b63c0d55df
|
|
| BLAKE2b-256 |
7a4e7aee12892a94736140fa467125cec2449681ac26b50ede9c9d2099df0afc
|
Provenance
The following attestation bundles were made for simplexng-0.1.2-py3-none-any.whl:
Publisher:
publish.yml on jlevy/simplexng
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
simplexng-0.1.2-py3-none-any.whl -
Subject digest:
f8802bc2649dfd6b89058f932055de477ecc7e12161ba57bb41b3772a6430a03 - Sigstore transparency entry: 223427957
- Sigstore integration time:
-
Permalink:
jlevy/simplexng@c0149f3d48c0ba946b7cf155df5b167ad25a53c5 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/jlevy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c0149f3d48c0ba946b7cf155df5b167ad25a53c5 -
Trigger Event:
release
-
Statement type: