https://github.com/ArchiveBox/archivebox-browser-extension
Official ArchiveBox browser extension: automatically/manually preserve your browsing history using ArchiveBox.
https://github.com/ArchiveBox/archivebox-browser-extension
archivebox archiving browser-extension chrome-extension digipres digital-preservation firefox-extension internet-archiving svelte web-archiving
Last synced: 13 days ago
JSON representation
Official ArchiveBox browser extension: automatically/manually preserve your browsing history using ArchiveBox.
- Host: GitHub
- URL: https://github.com/ArchiveBox/archivebox-browser-extension
- Owner: ArchiveBox
- License: mit
- Created: 2021-06-30T04:32:53.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-14T20:13:10.000Z (about 1 month ago)
- Last Synced: 2025-03-14T21:27:38.776Z (about 1 month ago)
- Topics: archivebox, archiving, browser-extension, chrome-extension, digipres, digital-preservation, firefox-extension, internet-archiving, svelte, web-archiving
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/archivebox-exporter/habonpimjphpdnmcfkaockjnffodikoj
- Size: 558 KB
- Stars: 284
- Watchers: 9
- Forks: 27
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rainmana - ArchiveBox/archivebox-browser-extension - Official ArchiveBox browser extension: automatically/manually preserve your browsing history using ArchiveBox. (JavaScript)
README
# 🗃 ArchiveBox Browser Extension
This is a browser extension that lets you send individual browser tabs or all URLs matching certain patterns to your [ArchiveBox](https://github.com/ArchiveBox/ArchiveBox) instance for offline preservation. This has a couple of benefits:
- Own your data: save the web content that matters to you most, protect against link rot
- Protect your data: save offline copies of pages in common, durable formats that will last for generations
- Use your data: collect and tag important bookmarks, full-text search through your browsing history, automatically push captured data into other systems using ArchiveBox's APIs
## Get the Extension
- 
Chrome / Brave / Edge / Other Chromium-based browsers
- 
Firefox / Waterfox / Tor Browser / Other Firefox-based browsers
- 
Safari *(not yet supported, use [Save-to-ArchiveBox Shortcut](https://www.icloud.com/shortcuts/0d3a526e7d524447aa8c1bd63ac49014) instead)*
#### Recent Changes
- [x] update to manifest v3 to re-submit to Chrome web store
- [x] added an admin view where you can see a list of all the URLs you've collected so far
- [x] added ability to search admin view by url, timestamp, uuid, tags
- [x] added the ability to export filtered URLs list from history as CSV and JSON
- [x] added the ability to import URLs from chrome history / bookmarks by daterange or filter query
- [x] add the ability to edit extension config options, allowlist/denylist, etc. from options.html
- [x] add the ability to test connection to ArchiveBox server
## Setup
1. Set up an [ArchiveBox](https://github.com/ArchiveBox/ArchiveBox#quickstart) server and make sure it's accessible to the machine you're browsing on
2. Configure your ArchiveBox server to allow URL submissions without requiring login ([more info here...](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view))
*`>= v0.8.5`: users of the new BETA releases can use an API key generated at `/admin/api/apitoken/` instead.*
*Alternatively: if you stay signed in to your ArchiveBox instance in the same browser, it will share your login credentials.*
```bash
archivebox config --set PUBLIC_ADD_VIEW=True
# (make sure to restart the server after if you apply this change)
```
4. Configure the extension to point to your ArchiveBox server's base URL (e.g. `http://localhost:8000`, `https://archivebox.example.com`, etc.)
5. ✅ *Test it out by right-clicking on any page and selecting `Save to ArchiveBox`, or by clicking the extension icon in the menubar.*
---
## Development
*✨ Originally contributed by [TJ Horner (@tjhorner)](https://github.com/tjhorner), now maintained by [@benmuth](https://github.com/benmuth) and the [ArchiveBox](https://github.com/ArchiveBox) team.*
If you wish to contribute to (or just build for yourself) this extension, you will need to download and install [Node.js](https://nodejs.org/en/).
```bash
git clone https://github.com/ArchiveBox/archivebox-browser-extension
cd archivebox-browser-extension/
# There is no build step with v2.1.3 and above, the project uses vanilla ESM JS.
# Simply load the entire directory as an unpacked extension in Chrome
```
Load the root repo folder into Chrome or Firefox using their [Load Unpacked Extension](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked) UI.
Please open an issue to discuss any proposed changes *before* starting work on any PRs.
## Changelog
- 2025-03 New Manifest v3 [Extension v2.1.3](https://github.com/ArchiveBox/archivebox-browser-extension/releases/tag/v2.1.3) Released
- 2024-11 Development [started](https://github.com/ArchiveBox/archivebox-browser-extension/pull/31) on v2 extension with more advanced UI and tagging options
- 2024-01 Extension repo moved from `tjhorner/archivebox-exporter` to `Archivebox/archivebox-browser-extension`
- 2021-09 Extension offically supported by ArchiveBox v0.6.2, no longer needed to run `:dev` branch
- 2021-07 Initial extension [published](https://github.com/ArchiveBox/ArchiveBox/issues/577#issuecomment-872915877) on Chrome and Mozilla web stores
- 2021-06 [@tjhorner](https://github.com/tjhorner) [Created](https://github.com/ArchiveBox/ArchiveBox/issues/577) the initial `archivebox-exporter` extension
---
## Alternative Extensions for Archiving
Other browser extensions that also do web archiving which may be a better fit if ArchiveBox doesn't suit your needs.
- [ArchiveWeb.page](https://webrecorder.net/archivewebpage) (super high fidelity archiving extension by Webrecorder)
- [SingleFile](https://github.com/gildas-lormeau/SingleFile) (a great extension for saving pages into a single `.html` file, built-in to ArchiveBox already)
- [Hypothesis](https://web.hypothes.is/start/) (extension focused on annotating, but also supports archiving)
- [Memex](https://memex.garden/) (another project focused on annotating that supports archiving)
- [Save Page WE](https://addons.mozilla.org/en-US/firefox/addon/save-page-we/) (a Firefox extension that also saves webpages as a single HTML file)
## Other ArchiveBox Helper Projects
Other projects that help with ingest URLs into ArchiveBox from various sources.
- https://github.com/layderv/archivefox (user-contributed extension for Firefox)
- https://github.com/Gertje823/ArchiveboxTelegramBot (Telegram Bot to send URLs to ArchiveBox)
- https://github.com/TheCakeIsNaOH/xbs-to-archivebox (Download your bookmarks from xBrowserSync, filter them, and save them into ArchiveBox)
- https://github.com/emschu/archivebox-quick-add (golang utility to add links to ArchiveBox)
- https://github.com/FracturedCode/archivebox-reddit (automatically back up saved Reddit comments, posts, etc. to ArchiveBox)
- https://github.com/dbeley/reddit_export_userdata (older Python utility to archive reddit content to ArchiveBox)
- https://github.com/jess-sol/reddit-exporter (export reddit data to ArchiveBox)
- https://github.com/jonesd/archivebox-pinboard-tranformer (export links from pinboard to ArchiveBox)
- https://github.com/agg23/archivebox-url-forwarder (older WebExtension to forward URLs to archivebox)
---
## License
MIT License