mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-24 07:03:03 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2024-03-19 17:32:20 -07:00
parent 5a1e1e3623
commit 5c2de6d85d
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
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.*
<img width="400" align="right" alt="browser extension config screen" src="https://user-images.githubusercontent.com/511499/215702958-4683af8f-7f1e-4b0e-a313-2466b9cf0276.png"/>
<img width="400" align="top" alt="chrome web store screenshot" src="https://user-images.githubusercontent.com/511499/215699375-5c98c9bb-56fd-4a46-a990-e5745d46019c.png"/><br/><img width="400" alt="image" src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/1c00c64e-4d02-4cf1-b270-2ff4e1b8e02f">
<img width="350" align="top" alt="chrome web store screenshot" src="https://user-images.githubusercontent.com/511499/215699375-5c98c9bb-56fd-4a46-a990-e5745d46019c.png"/><br/><img width="400" alt="image" src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/1c00c64e-4d02-4cf1-b270-2ff4e1b8e02f">
See https://github.com/ArchiveBox/ArchiveBox/issues/577 for more information.