add docs links and usage to docker-compose.yml

This commit is contained in:
Nick Sweeting 2019-02-28 13:59:52 -05:00 committed by GitHub
parent 552734241b
commit 3e6bcb3b39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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' version: '3'
services: services:
@ -5,6 +15,7 @@ services:
build: . build: .
stdin_open: true stdin_open: true
tty: true tty: true
# env_file: path/to/your/ArchiveBox.conf
environment: environment:
- USE_COLOR=False - USE_COLOR=False
- SHOW_PROGRESS=False - SHOW_PROGRESS=False