From 50f2ab1e342635d4ec8e70d0479e5c4e4a7ed36d Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 16 Jan 2019 07:59:23 -0500 Subject: [PATCH] Updated Install (markdown) --- Install.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/Install.md b/Install.md index f94c144..66939f0 100644 --- a/Install.md +++ b/Install.md @@ -64,16 +64,27 @@ If you have any trouble, see the [Troubleshooting](#troubleshooting) section at Docker support for ArchiveBox is in beta, I'll update it as we improve the ergonomics and add an example `docker-compose.yml` file for serving the archive with nginx. -Currently, you can run ArchiveBox with Docker like this: +1. Make sure you have Docker installed and set up: +Follow their install instructions for Linux, macOS, or Windows https://docs.docker.com/install/#supported-platforms. +2. Fetch and build the ArchiveBox Docker image: ```bash docker build github.com/pirate/ArchiveBox -t ArchiveBox +``` + +3. Create a volume to hold your ArchiveBox data: +```bash docker volume create archivebox-data +``` + +4. Run ArchiveBox with `docker run` to add links to your archive: + +To add a list of pages via URL of a feed. +```bash docker run -v archivebox-data:/home/chromeuser/app/archivebox/output ArchiveBox 'https://example.com/some/rss/feed.xml' ``` -It's not perfect yet, I still have to improve the system for passing in link files to parse, right now you have to put them in the data volume and then reference them by their path inside the container to get ArchiveBox to find them: - +To add a single link or a list of links from a file, pipe them in via stdin. ```bash -docker run -v archivebox-data:/home/chromeuser/app/archiver/output ArchiveBox /home/chromeuser/app/archivebox/output/downloads/path-to-links.json -``` +echo 'https://example.com' | docker run -i -v archivebox-data:/home/chromeuser/app/archivebox/output ArchiveBox +``` \ No newline at end of file