Skip to main content

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.

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:

  • It 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.)

  • It vendors a recent copy of SearXNG so it is all available from PyPI for quick installation.

I wrote this since a friend was asking me why it wasn't easier to set up for "localhost" use or embedded use. So I thought I'd see if it worked as a minimal, modern uv package.

Running

Install uv if you haven't already.

To install:

uv tool install simplexng

To run:

simplexng --open

More options:

simplexng --help

Notes:

  • 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
    

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

simplexng-0.1.1.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simplexng-0.1.1-py3-none-any.whl (4.9 MB view details)

Uploaded Python 3

File details

Details for the file simplexng-0.1.1.tar.gz.

File metadata

  • Download URL: simplexng-0.1.1.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

Hashes for simplexng-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4eb7c09ea150b94994fce277bbf5a37c00209b9af36f0981a51dace567bb80d8
MD5 85ed143ebbf490eb51657026ecc79941
BLAKE2b-256 7966b3a3dea08315fc9725c6983c31330afecdb8773dd4237993567d6a29ac79

See more details on using hashes here.

Provenance

The following attestation bundles were made for simplexng-0.1.1.tar.gz:

Publisher: publish.yml on jlevy/simplexng

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simplexng-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: simplexng-0.1.1-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

Hashes for simplexng-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d12a534b2e813dda987a700dbe3307de947171e759a011e337e7f2ef048ad2a4
MD5 2465ec294831981d42b3d69600acc79d
BLAKE2b-256 ff8a3832f3b6e40e0c3b2447d6485adc96c44f5f2bd524e93d09bd1166c1e2e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for simplexng-0.1.1-py3-none-any.whl:

Publisher: publish.yml on jlevy/simplexng

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page