Go to file

ge 21e3ae3b1c init		2023-04-26 16:22:48 +03:00
cursed_archivebox_api.py	init	2023-04-26 16:22:48 +03:00
Pipfile	init	2023-04-26 16:22:48 +03:00
Pipfile.lock	init	2023-04-26 16:22:48 +03:00
README.md	init	2023-04-26 16:22:48 +03:00
requirements.txt	init	2023-04-26 16:22:48 +03:00

README.md

Cursed API for ArchiveBox

ArchiveBox doesn't have a web API yet. This is shitty single-endpoint API to automate page archiving. It uses subprocess to run archivebox CLI. archivebox CLI runs in new thread to avoid blocking main thread.

Install and run

Install dependencies:

pip install bottle gunicorn

Start API on server where ArchiveBox container is running. Set actual path to docker-compose.yml.

ARCHIVEBOX_BIN="docker compose -f /opt/archievebox/docker-compose.yml run archivebox" python cursed_archivebox_api.py

Environment

Variable	Default
`ARCHIVEBOX_BIN`	`/usr/bin/archivebox` (default for non-Docker installations)
`CURSED_PORT`	`9998`
`CURSED_HOST`	`0.0.0.0`
`CURSED_SERVER`	`gunicorn` See server backends

GET /add

Query parameters:

url. Resource URL
depth. Archive depth. Default: 0 (current page)
tag. List of comma separated tags e.g. my_tag, my_tag,another_one.

Example:

curl -i 'http://localhost:9998/add?url=https://example.com&depth=0&tag=api,example'