Quickstart

Nick Sweeting edited this page Feb 4, 2019 · 25 revisions

▶️ It only takes 5 minutes to get up and running.

ArchiveBox officially supports Ubuntu, FreeBSD, and macOS, but likely runs on many other systems. You can run it on any system that supports Docker, including Windows.

First, we install the ArchiveBox dependencies, then we create a folder to store the archive data, and finally we import the list of links to the archive by running ./archive <links_file>.

1. Create your archive

Create a folder to store your archive, and clone the ArchiveBox repo into it.

git clone https://github.com/pirate/ArchiveBox
cd ArchiveBox/
./setup   # installs all dependencies

For more detail, including the manual setup and docker instructions, see the Install page.

2. Get your list of URLs to archive

Follow the links here to find instructions for exporting a list of URLs from each service.

(If any of these links are broken, please submit an issue and I'll fix it)

3. Archive your list of URLs

To add a list of links from a file:

./archive ~/Downloads/bookmark_export.html      # replace with the path to your export file or URL from step 1

Or you can pass in URLs to archive via stdin:

echo 'https://example.com' | ./archive

✅ Done!

You can open output/index.html to view your archive. (favicons will appear next to each title once it has finished downloading)


Next Steps:

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.