Repository files navigation

This is a browser extension that lets you send individual browser tabs or all URLs matching certain patterns to yourArchiveBox 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

• Chrome / Brave / Edge / Other Chromium-based browsers
• Firefox / Waterfox / Tor Browser / Other Firefox-based browsers
• Safari(not yet supported, useSave-to-ArchiveBox Shortcut instead)

• update to manifest v3 to re-submit to Chrome web store
• added an admin view where you can see a list of all the URLs you've collected so far
• added ability to search admin view by url, timestamp, uuid, tags
• added the ability to export filtered URLs list from history as CSV and JSON
• added the ability to import URLs from chrome history / bookmarks by daterange or filter query
• add the ability to edit extension config options, allowlist/denylist, etc. from options.html
• add the ability to test connection to ArchiveBox server

1. Set up anArchiveBox 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...)
   >= 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.

   archivebox config --set PUBLIC_ADD_VIEW=True# (make sure to restart the server after if you apply this change)

   
3. Configure the extension to point to your ArchiveBox server's base URL (e.g.http://localhost:8000,https://archivebox.example.com, etc.)
   
4. ✅Test it out by right-clicking on any page and selectingSave to ArchiveBox, or by clicking the extension icon in the menubar.
   

✨ Originally contributed byTJ Horner (@tjhorner), now maintained by@benmuth and theArchiveBox team.

If you wish to contribute to (or just build for yourself) this extension, you will need to download and installNode.js.

git clone https://github.com/ArchiveBox/archivebox-browser-extensioncd 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 theirLoad Unpacked Extension UI.

Please open an issue to discuss any proposed changesbefore starting work on any PRs.

• 2025-03 New Manifest v3Extension v2.1.3 Released
• 2024-11 Developmentstarted on v2 extension with more advanced UI and tagging options
• 2024-01 Extension repo moved fromtjhorner/archivebox-exporter toArchivebox/archivebox-browser-extension
• 2021-09 Extension offically supported by ArchiveBox v0.6.2, no longer needed to run:dev branch
• 2021-07 Initial extensionpublished on Chrome and Mozilla web stores
• 2021-06@tjhornerCreated the initialarchivebox-exporter extension

Other browser extensions that also do web archiving which may be a better fit if ArchiveBox doesn't suit your needs.

• ArchiveWeb.page (super high fidelity archiving extension by Webrecorder)
• SingleFile (a great extension for saving pages into a single.html file, built-in to ArchiveBox already)
• Hypothesis (extension focused on annotating, but also supports archiving)
• Memex (another project focused on annotating that supports archiving)
• Save Page WE (a Firefox extension that also saves webpages as a single HTML file)

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)

MIT License