Skip to content

Commit

Permalink
add Docker installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
notslang committed Sep 13, 2016
1 parent 5b27880 commit 23f9099
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Note: grab-site currently **does not work with Python 3.5**; please use Python 3
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Contents**

- [Install with Docker](#install-with-docker)
- [Install on Ubuntu 14.04 - 15.10](#install-on-ubuntu-1404---1510)
- [Install on Ubuntu 16.04](#install-on-ubuntu-1604)
- [Install on a non-Ubuntu distribution lacking Python 3.4.x](#install-on-a-non-ubuntu-distribution-lacking-python-34x)
Expand All @@ -55,6 +56,27 @@ Note: grab-site currently **does not work with Python 3.5**; please use Python 3

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Install with Docker
---
After [installing Docker](https://docs.docker.com/engine/installation/), get the pre-built container:

```bash
docker pull slang800/grab-site
```

Start the grab-site server. You can set the port, volume, and name to whatever you want:

```bash
docker run --detach -p 29000:29000 -v /home/ludios/download/grab-site-data:/data --name warcfactory slang800/grab-site
```

Run a new crawl:

```bash
docker exec warcfactory grab-site --no-offsite-links --1 http://xkcd.com/
```

The downloaded data, temp files, ignores list, and other configuration will be in a sub-directory of the mounted volume. In this case, `/home/ludios/download/grab-site-data/xkcd.com-2016-09-05-caf0a39c`.

Install on Ubuntu 14.04 - 15.10
---
Expand Down

0 comments on commit 23f9099

Please sign in to comment.