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.

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

  1. Install uv if you haven’t already.

  2. Install and run:

    uv tool install --upgrade simplexng
    simplexng --open
    

    Or if you’re in a hurry, in one line:

    uvx --upgrade simplexng --open
    

    This will install the latest version of SimpleXNG and open it in your browser.

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
    

Thoughts?

If this is useful or of interest or have feedback, file an issue or drop a comment on my post about SimpleXNG.

License

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

simplexng-0.1.3.tar.gz (4.8 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.3-py3-none-any.whl (5.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simplexng-0.1.3.tar.gz
  • Upload date:
  • Size: 4.8 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.3.tar.gz
Algorithm Hash digest
SHA256 054e495b6e0a8d378bd717f143b42cea9e7e3586ab30020f8a02f157c7310458
MD5 33d4319cd0f628a7e7a89ae81eb1ece1
BLAKE2b-256 4870e634ee9e0086d0ef277a39eb1a006e5a0ed809cf3ff56521329222d04acf

See more details on using hashes here.

Provenance

The following attestation bundles were made for simplexng-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: simplexng-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0f0a19a3b2e7aae53395a6c83d29e5a833586daa6d933e548e7f2a20a357349d
MD5 6d3e3660c1f8c452493bef9f3c7c3785
BLAKE2b-256 51440e20ffd1ce42899b953e522bf64e3d791205a36b75f9319ddd599ff235ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for simplexng-0.1.3-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