https://github.com/make-github-pseudonymous-again/recoll-api-rest
https://github.com/make-github-pseudonymous-again/recoll-api-rest
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/make-github-pseudonymous-again/recoll-api-rest
- Owner: make-github-pseudonymous-again
- Created: 2023-10-11T21:01:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-26T17:25:06.000Z (over 2 years ago)
- Last Synced: 2025-01-18T15:53:37.877Z (about 1 year ago)
- Language: Python
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
`recoll-api-rest`
==
> :phone: A REST API to communicate with the
> [`recoll`](https://www.lesbonscomptes.com/recoll) database.
## `build`
The image exposes the HTTP API on port `80` and expects
read-only access to a recoll index at `/index`.
```sh
docker build -t recoll-api-rest:latest .
```
## `run`
A `compose.yaml` file allows to easily configure and run the docker
image with `RECOLL_CONFDIR` and `PORT`.
```sh
env RECOLL_CONFDIR="$HOME/.recoll" PORT=8080 docker compose up -d
```
## `stop`
```sh
env RECOLL_CONFDIR="$HOME/.recoll" PORT=8080 docker compose down
```