diff --git a/docker-compose.yml b/docker-compose.yml index 0a6fe715..631ebcf7 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,3 +1,13 @@ +# This docker-compose config for ArchiveBox runs the following containers: +# - ArchiveBox (it creates the initial archive, then sleeps forever to allow commands to be run with exec to add links) +# - nginx webserver running on https://127.0.0.1:8098 +# Usage: +# docker-compose up -d +# echo "https://example.com" | docker-compose exec -T archivebox /bin/archive +# docker-compose exec archivebox /bin/archive https://example.com/some/feed.rss +# Documentation: +# https://github.com/pirate/ArchiveBox/wiki/Docker#docker-compose + version: '3' services: @@ -5,6 +15,7 @@ services: build: . stdin_open: true tty: true + # env_file: path/to/your/ArchiveBox.conf environment: - USE_COLOR=False - SHOW_PROGRESS=False