Install

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

System Support

ArchiveBox officially supports the following operating systems:

  • Linux: e.g. Ubuntu, Debian, etc (with apt)
  • BSD: FreeBSD, OpenBSD, NetBSD etc (with pkg)
  • macOS (with homebrew)

You can run it on Windows and other systems via Docker containers or Vagrant VMs if they have support for those technologies. I haven't tested it on distros like Fedora, SUSE, Arch, CentOS, etc but you can probably get it working on those as well.

Dependencies

Not all the dependencies are required for all modes. If you disable some archive methods you can avoid those dependencies, for example, if you set FETCH_MEDIA=False you don't need to install youtube-dl, and if you set FETCH_[PDF,SCREENSHOT,DOM]=False you don't need chromium.

  • python3 >= 3.5
  • wget >= 1.16
  • chromium >= 59 (google-chrome >= v59 works fine as well)
  • youtube-dl
  • curl (usually already on most systems)
  • git (usually already on most systems)

For help installing specific dependencies, see the Troubleshooting page.

Automatic Setup

If you're on Linux with apt, or macOS with brew:

Run ./bin/setup, it will prompt you to install all dependencies and set up ArchiveBox automatically.

Then continue with the Quickstart...

BSD and Windows users should follow the manual setup and Docker instructions respectively.

Manual Setup

If you don't like running random setup scripts off the internet (:+1:), you can follow these manual setup instructions.

1. Install dependencies:

# On Ubuntu/Debian:
apt install chromium-browser python3 wget curl youtube-dl git
# On Mac:
brew cask install chromium  # If you already have Google Chrome/Chromium in /Applications/, skip this command
brew install python3 wget curl youtube-dl git

echo -e '#!/bin/bash\n/Applications/Chromium.app/Contents/MacOS/Chromium "$@"' > /usr/local/bin/chromium-browser
chmod +x /usr/local/bin/chromium-browser
# Check that everything worked and the versions are high enough:
chromium-browser --version && which wget && which python3 && which curl && echo "[√] All dependencies installed."

If you have issues setting up Chromium / Google Chrome, see the Chromium Install page for more detailed setup instructions.

2. Get your bookmark export file:

Follow the Quickstart guide to download your bookmarks export file containing a list of links to archive.

3. Run the archive script:

  1. Clone this repo git clone https://github.com/pirate/ArchiveBox
  2. cd ArchiveBox/
  3. ./archive ~/Downloads/links_list.html

You may optionally specify a second argument to archive.py export.html 153242424324 to resume the archive update at a specific timestamp.

Next Steps:

Docker Setup

First, if you don't already have docker installed, follow the official install instructions for Linux, macOS, or Windows https://docs.docker.com/install/#supported-platforms.

Then see the Docker page for 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.