mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-26 15:54:36 +02:00
Code Issues Releases Wiki Activity

Updated Quickstart (markdown)

Nick Sweeting
2021-04-06 15:29:24 -04:00
parent f3763d532c
commit 759816bdc7
1 changed files with 1 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Quickstart.md

@@ -17,21 +17,7 @@ First, we install the ArchiveBox [dependencies](./Install#dependencies), then we
## 1. Set up ArchiveBox ## 1. Set up ArchiveBox
We recommend using Docker because it has all the extractors and dependencies working out-of-the-box: Follow the [README Quickstart Instructions](https://github.com/ArchiveBox/ArchiveBox#quickstart) for your platform to get archivebox set up.
```bash
# first make sure you have docker: https://docs.docker.com/get-docker/
# then run this to get started with a collection in the current directory
docker run -v $PWD:/data -it archivebox/archivebox init --setup
# alternatively, install ArchiveBox and its dependencies directly on your system without docker
# by following the instructions in the README.md
```
(The above are shell commands to run. If you're not used to those, consult your operating system's manual for how to run a terminal emulator.)
For more details, including the manual setup and docker instructions, see the [[Install]] page or the [README Quickstart Instructions](https://github.com/ArchiveBox/ArchiveBox#quickstart).
## 2. Get your list of URLs to archive ## 2. Get your list of URLs to archive