Skip to content

ArchiveBox/archivebox-browser-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🗃 ArchiveBox Browser Extension

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

✨ Originally contributed by TJ Horner (@tjhorner), now maintained by the ArchiveBox team.

Download

Setup

  1. Set up an ArchiveBox 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...)
    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)
    Screenshot of ArchiveBox CLI configuring PUBLIC_ADD_VIEW=True
  3. Configure the extension to point to your ArchiveBox server's base URL (e.g. http://localhost:8000, https://archivebox.example.com, etc.)
    Screenshot of extension config area: example with localhostScreenshot of extension config area: example with demo
  4. Test it out by right-clicking on any page and selecting ArchiveBox Exporter > Archive Current Page
    Screenshot of right-clicking to add a page to ArchiveBox using extensionScreenshot of ArchiveBox server with added URL

Features

  • Different archive modes
    • Allowlist mode doesn't archive pages by default, and lets you specify domains or regexes to archive
    • Blocklist mode archives all visited pages by default, but lets you specify domains or regexes to not archive
  • Archive any arbitrary page with the "Archive Current Page" context menu item
  • Archive any link with the "Archive Link" context menu item

Development

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

git clone https://github.com/ArchiveBox/archivebox-browser-extension
cd archivebox-browser-extension/

npm install
npm run build

# or for hot-reloading during development:
npm run dev

Both commands will produce an output in the dist/ directory, load that folder into Chrome or Firefox using their Load Unpacked Extension UI.

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

Changelog

  • 2024-11 Development started 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 on Chrome and Mozilla web stores
  • 2021-06 @tjhorner Created the initial archivebox-exporter extension

Alternative Extensions for Archiving

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

Other ArchiveBox Helper Projects

Other projects that help with ingest URLs into ArchiveBox from various sources.


License

MIT License