diff --git a/Usage.md b/Usage.md index 9e9ccbc..3b7f065 100644 --- a/Usage.md +++ b/Usage.md @@ -162,18 +162,21 @@ A logged-in admin user may perform these operations on one or more snapshots: ## Browser Extension Usage -Get the official [ArchiveBox Browser Extension](https://github.com/ArchiveBox/archivebox-browser-extension): +Set up the official [ArchiveBox Browser Extension](https://github.com/ArchiveBox/archivebox-browser-extension) to submit specific pages or your entire browsing history to an ArchiveBox server in realtime. -1. Log into your ArchiveBox server using your admin user/pass (the extension will re-use this login session to submit URLs), or configure Archivebox allow submitting URLs without logging in `archivebox config --set PUBLIC_ADD_VIEW=True` - (see [`PUBLIC_ADD_VIEW` in the wiki](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view)) -2. Install the extension in your browser: +1. Install the extension in your browser: - [Chrome/Edge/Other Chromium](https://chrome.google.com/webstore/detail/habonpimjphpdnmcfkaockjnffodikoj) - [Firefox](https://addons.mozilla.org/en-US/firefox/addon/archivebox-exporter/) -3. Set the `BASE_URL` in the extension to your ArchiveBox server's URL, e.g. `http://localhost:8000` -4. ✅ Done! Test it out: `Right-click on any page > ArchiveBox Exporter > Archive Current Page`, then check your ArchiveBox instance to confirm it got archived. +2. Make sure you can access your ArchiveBox server's admin interface from your browser (e.g. `http://localhost:8000/admin/`). + The extension will re-use any active login session to submit URLs to your server, so make sure to log in! + *Alternatively:* You can configure Archivebox [allow submitting URLs without requiring log-in](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view) + `archivebox config --set PUBLIC_ADD_VIEW=True` +3. Click the ArchiveBox extension in your browser and set `Config > BASE_URL` to your ArchiveBox server's URL, e.g. `http://localhost:8000` +4. ✅ Done! Test it out: `Right-click on any page > ArchiveBox Exporter > Archive Current Page` + *Then check your ArchiveBox instance to confirm it got archived.* browser extension config screen -chrome web store screenshot
image +chrome web store screenshot
image See https://github.com/ArchiveBox/ArchiveBox/issues/577 for more information.