Skip to content
Nick Sweeting edited this page Jan 29, 2024 · 9 revisions

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.

Second, you need to sign in to your ArchiveBox on the same browser the extension is installed on (it will share credentials). Or, if your add page is public (i.e., you have PUBLIC_ADD_VIEW set to true), then you can just stay signed out.

Setup

Setup is super simple! All you need to do is set your ArchiveBox's base URL in the "Config" section of the extension. Enter it with the full protocol, hostname, and port (if needed). For example, if your ArchiveBox instance is exposed to the internet with HTTPS and a domain set up at https://archivebox.example.com, that is what you would set in this field. Alternatively, if you are running ArchiveBox locally on port 8000 (not exposed with a public domain), you would enter: http://localhost:8000.

Configure the extension with the domains and regexes you'd like to archive (or, if you're in blocklist mode, domains/regexes you'd like to ignore), and you're done. URLs will automatically be sent to your ArchiveBox for archival every 15 minutes. You can see more info regarding configuration here.

To test that everything works, right click on a page and choose "Archive Current Page" from the context menu, then check your ArchiveBox to see if it's there.

Help

If you are having issues setting up the extension, feel free to ask for help in the discussions section.

Clone this wiki locally