Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 3 months ago
JSON representation

Official ArchiveBox browser extension: automatically/manually preserve your browsing history using ArchiveBox.

Awesome Lists containing this project

README

        

# 🗃 ArchiveBox Browser Extension

This is a browser extension (works in Chrome, Firefox, and Chrome-like browsers) that lets you automatically send pages from domains you specify to your ArchiveBox instance. This has a couple of benefits:

- You have a fulltext search of your browsing history ready at your fingertips
- Prevent link rot for important information!
- Access important information even if you're offline

*✨ Contributed by [TJ Horner (@tjhorner)](https://github.com/tjhorner)*

## Download

- [Chrome/Edge/Other Chromium](https://chrome.google.com/webstore/detail/habonpimjphpdnmcfkaockjnffodikoj)
- [Firefox](https://addons.mozilla.org/firefox/addon/archivebox-exporter/)

## 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))
*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)
```
Screenshot of ArchiveBox CLI configuring PUBLIC_ADD_VIEW=True
4. 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
5. ✅ *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](https://nodejs.org/en/).

Once that's installed, navigate to this project's root and run `npm install` to install dependencies.

To build a production version (minified, optimized, etc.), run `npm run build`.

If you plan on making changes often, you can use the command `npm run dev` to automatically rebuild the extension as you modify files.

Both commands will produce an output in the `dist` directory.

## Changelog

#### 2024-01 Extension repo moved from `tjhorner/archivebox-exporter` to `Archivebox/archivebox-browser-extension`

https://github.com/ArchiveBox/archivebox-extension

#### 2021-09 Extension offically supported by ArchiveBox v0.6.2, no longer needed to run `:dev` branch

https://github.com/tjhorner/ArchiveBox.git#temporary-add-api

#### 2021-07 Initial extension published on Chrome and Mozilla web stores

https://github.com/ArchiveBox/ArchiveBox/issues/577#issuecomment-872915877

#### 2021-06 [@tjhorner](https://github.com/tjhorner) Created the initial `archivebox-exporter` extension

https://github.com/ArchiveBox/ArchiveBox/issues/577

---

## Alternative Extensions for Archiving

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

- https://archiveweb.page/ + https://replayweb.page (super high fidelity archiving extension by the Webrecorder team)
- https://github.com/gildas-lormeau/SingleFile (a great extension for saving pages into a single `.html` file, built-in to ArchiveBox already)
- https://web.hypothes.is/start/ (extension focused on annotating, but also supports archiving)
- https://memex.garden/ (another project focused on annotating that supports archiving)
- 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