Install & self-host

This section is the complete reference for installing, configuring, and running your own Yeliztli instance. If you just want the fastest path, the native install is recommended for day-to-day use.

Choose how to run it

• Native install — install the Python package and frontend, then run Yeliztli as a background service (launchd on macOS, systemd on Linux/WSL2). Best for daily use.
• Docker Compose — run the API and background worker as containers with a persistent data volume. Good if you already use Docker.
• Development mode — hot-reloading backend + frontend for contributors, via make dev. See the Develop section.

After installing

1. Open the app and complete the setup wizard — disclaimer, storage path, optional external services, reference-data download, and your first upload.
2. Understand what gets downloaded and how much space it needs: reference data.
3. Tune behaviour in configuration if you need non-default ports, authentication, or paths.

Check requirements first

Confirm your machine meets the system requirements — especially free disk space, which is larger than you might expect once the reference databases are downloaded.

Need help? See troubleshooting.