Setup

Thanks for installing ArchiveBox Exporter! Let's get you set up.

Prerequisites

First of all, you will need an instance of ArchiveBox server running somewhere. It needs to be accessible via HTTP.

You will also need to install a special version of ArchiveBox with a special API route, while ArchiveBox works on an official one. You can install this version over your existing ArchiveBox by running this command:

# using docker
docker build -t archivebox:temporary-add-api https://github.com/tjhorner/ArchiveBox.git#temporary-add-api
docker run -it -v $PWD:/data archivebox:temporary-add-api init --setup

# using pip or pip3
pip install --upgrade "git+https://github.com/tjhorner/ArchiveBox@temporary-add-api"

Next, you will need to edit your config to include an API key. Using whatever method you use to change your config, change API_KEY under SERVER_CONFIG to something unique and random.

Extension Setup

In the config section of the extension, set "ArchiveBox Base URL" to the base URL of your ArchiveBox instance. For example, https://example.com. Then in the "ArchiveBox API Key" field, enter the API key you set earlier.