27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# Typesense
|
|
|
|
Typesense is a self-hosted search engine that stores and serves indexed collections through its HTTP API.
|
|
|
|
## Deployment layout
|
|
|
|
- **Compose:** `/srv/docker/typesense/docker-compose.yml`
|
|
- **Static configuration/source:** no additional mounted configuration or local build source
|
|
- **Non-secret environment:** the data directory and CORS policy are declared as command arguments in Compose; there
|
|
is no project-local `.env`
|
|
- **Secrets:** `/srv/docker/secrets/typesense/.env`
|
|
- **NVMe application state:** `/srv/appdata/typesense/data`
|
|
- **Bulk HDD data:** none
|
|
- **Other mounts:** none
|
|
|
|
Secrets are never committed to this repository. The central secret environment supplies the required
|
|
`TYPESENSE_API_KEY` variable to the Typesense service.
|
|
|
|
## Dependencies and recovery
|
|
|
|
- **Networks/dependencies:** Typesense uses the external `npm_proxy` network at `192.168.96.16`; no Compose service
|
|
dependency is declared
|
|
- **Back up:** `/srv/appdata/typesense/data` and the separately protected Typesense secret environment
|
|
- **Re-creatable:** the Typesense container; index data is re-creatable only when every collection has an
|
|
authoritative upstream source and a tested reindex procedure
|
|
|