The fastest way to get Jiro running on your own infrastructure. Requires Python 3.10+ and Redis.
Step 1: Install
- pip install jirosearch
Step 2: Start the server
- jiro serve
Step 3: Verify
- curl http://localhost:8000/health
The server starts on port 8000 by default. All 9 search engines and 12 social platforms are available immediately. No API key is required for self-hosted instances unless you enable authentication.
Run Jiro in a Docker container for isolated and reproducible deployments:
Use docker-compose for a complete stack with Redis included:
Run Jiro as a systemd service for automatic startup and process management:
Jiro uses a YAML configuration file at ~/.jiro/config.yaml. All settings can also be overridden with environment variables prefixed with JIRO_ (double underscore __ for nested keys). Secrets can be interpolated from the environment using ${VAR} syntax.
All configuration options can be set via environment variables. Use JIRO_ prefix with double underscores __ for nested keys. Secrets can use ${VAR} interpolation in YAML.
| Name | Type | Description |
|---|---|---|
JIRO_SERVER__HOST | string | Server bind address. Default: `127.0.0.1`. |
JIRO_SERVER__PORT | integer | Server port. Default: `8000`. |
JIRO_SERVER__WORKERS | integer | Number of worker processes. Default: `1`. |
JIRO_AUTH__ENABLED | boolean | Enable API key authentication. Default: `true`. |
JIRO_CACHE__TYPE | string | Cache backend. Options: `sqlite`, `memory`, `redis`. Default: `sqlite`. |
JIRO_CACHE__TTL_SECONDS | integer | Cache TTL in seconds. Default: `3600`. |
JIRO_SCRAPING__DEFAULT_ENGINE | string | Default search engine. Default: `google`. |
JIRO_LLM__PROVIDER | string | LLM provider. Options: `openai`, `anthropic`, `gemini`, `openrouter`, `ollama`. Default: `openai`. |
JIRO_LLM__MODEL | string | LLM model name. Default: `gpt-4o-mini`. |
JIRO_LOGGING__LEVEL | string | Logging level. Options: `debug`, `info`, `warning`, `error`. Default: `info`. |
JIRO_LICENSE_TOKEN | string | Enterprise license token for unlocking premium features. |