{"id":13552826,"url":"https://github.com/ArchiveBox/archivebox-browser-extension","last_synced_at":"2025-04-03T04:30:51.297Z","repository":{"id":38393529,"uuid":"381575565","full_name":"ArchiveBox/archivebox-browser-extension","owner":"ArchiveBox","description":"Official ArchiveBox browser extension: automatically/manually preserve your browsing history using ArchiveBox.","archived":false,"fork":false,"pushed_at":"2025-03-14T20:13:10.000Z","size":571,"stargazers_count":284,"open_issues_count":12,"forks_count":27,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-14T21:27:38.776Z","etag":null,"topics":["archivebox","archiving","browser-extension","chrome-extension","digipres","digital-preservation","firefox-extension","internet-archiving","svelte","web-archiving"],"latest_commit_sha":null,"homepage":"https://chromewebstore.google.com/detail/archivebox-exporter/habonpimjphpdnmcfkaockjnffodikoj","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArchiveBox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-30T04:32:53.000Z","updated_at":"2025-03-14T20:13:14.000Z","dependencies_parsed_at":"2024-12-15T11:21:45.761Z","dependency_job_id":"7f4c9ee3-877c-4e4b-b8ed-83f02ee9941b","html_url":"https://github.com/ArchiveBox/archivebox-browser-extension","commit_stats":null,"previous_names":["archivebox/archivebox-extension","archivebox/archivebox-browser-extension"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchiveBox%2Farchivebox-browser-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchiveBox%2Farchivebox-browser-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchiveBox%2Farchivebox-browser-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchiveBox%2Farchivebox-browser-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArchiveBox","download_url":"https://codeload.github.com/ArchiveBox/archivebox-browser-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246939122,"owners_count":20857916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archivebox","archiving","browser-extension","chrome-extension","digipres","digital-preservation","firefox-extension","internet-archiving","svelte","web-archiving"],"created_at":"2024-08-01T12:02:11.168Z","updated_at":"2025-04-03T04:30:51.290Z","avatar_url":"https://github.com/ArchiveBox.png","language":"JavaScript","readme":"# 🗃 ArchiveBox Browser Extension\n\nThis 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:\n\n- Own your data: save the web content that matters to you most, protect against link rot\n- Protect your data: save offline copies of pages in common, durable formats that will last for generations\n- 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\n\n## Get the Extension\n\n- \u003ca href=\"https://chrome.google.com/webstore/detail/habonpimjphpdnmcfkaockjnffodikoj\"\u003e\u003cimg src=\"https://github.com/user-attachments/assets/4ee7d4fb-e676-4a75-973d-ac029f265b86\" height=\"30px\" align=\"top\"/\u003e Chrome / Brave / Edge / Other Chromium-based browsers\u003c/a\u003e\n- \u003ca href=\"https://addons.mozilla.org/firefox/addon/archivebox-exporter/\"\u003e\u003cimg src=\"https://github.com/user-attachments/assets/8e2a969d-68d6-4bd6-8b10-d8b5a36757ec\" height=\"30px\" align=\"top\"/\u003e Firefox / Waterfox / Tor Browser / Other Firefox-based browsers\u003c/a\u003e\n- \u003cimg src=\"https://github.com/user-attachments/assets/c20f8f8a-01f2-427b-ac75-ffddcb62953f\" height=\"30px\" align=\"top\"/\u003e Safari *(not yet supported, use [Save-to-ArchiveBox Shortcut](https://www.icloud.com/shortcuts/0d3a526e7d524447aa8c1bd63ac49014) instead)*\n\n![configuring-server](https://github.com/user-attachments/assets/308c4462-ca09-434f-89a6-3f6bac404be2)\n![url-submission](https://github.com/user-attachments/assets/cfc8f670-562a-4c17-a533-4b1b0560c5c8)\n![admin-ui](https://github.com/user-attachments/assets/97d90d4c-d0f3-4bc1-b7ef-1c9e410c576f)\n\n\u003cimg width=\"1367\" alt=\"image\" src=\"https://github.com/user-attachments/assets/393da1fa-c75a-4ab8-ae98-5745dca4683c\"\u003e\n\u003cimg width=\"2056\" alt=\"image\" src=\"https://github.com/user-attachments/assets/4290f090-3e33-4a12-82b8-65bafd86a2ee\"\u003e\n\n![image](https://github.com/user-attachments/assets/2977d572-9086-4ea7-a4a2-2726e762a125)\n![image](https://github.com/user-attachments/assets/bb2f2bde-5c40-48e4-9499-1fada83425cf)\n\u003cimg width=\"1402\" alt=\"image\" src=\"https://github.com/user-attachments/assets/aeb7ed60-d9b0-4393-8c71-2aa42921f7a2\"\u003e\n\n#### Recent Changes\n\n- [x] update to manifest v3 to re-submit to Chrome web store\n- [x] added an admin view where you can see a list of all the URLs you've collected so far\n- [x] added ability to search admin view by url, timestamp, uuid, tags\n- [x] added the ability to export filtered URLs list from history as CSV and JSON \n- [x] added the ability to import URLs from chrome history / bookmarks by daterange or filter query\n- [x] add the ability to edit extension config options, allowlist/denylist, etc. from options.html\n- [x] add the ability to test connection to ArchiveBox server\n\n\n\n\n## Setup\n\n1. Set up an [ArchiveBox](https://github.com/ArchiveBox/ArchiveBox#quickstart) server and make sure it's accessible to the machine you're browsing on\n2. 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))  \n    *`\u003e= v0.8.5`: users of the new BETA releases can use an API key generated at `/admin/api/apitoken/` instead.*  \n    *Alternatively: if you stay signed in to your ArchiveBox instance in the same browser, it will share your login credentials.*\n    ```bash\n    archivebox config --set PUBLIC_ADD_VIEW=True\n    # (make sure to restart the server after if you apply this change)\n    ```\n    \u003cimg width=\"400\" alt=\"Screenshot of ArchiveBox CLI configuring PUBLIC_ADD_VIEW=True\" src=\"https://github.com/ArchiveBox/archivebox-extension/assets/511499/b0dc715c-4f88-49dd-a019-ffd65ebcc7c4\"\u003e\n4. Configure the extension to point to your ArchiveBox server's base URL (e.g. `http://localhost:8000`, `https://archivebox.example.com`, etc.)  \n    \u003cimg width=\"500\" alt=\"Screenshot of extension config area: example with localhost\" src=\"https://github.com/user-attachments/assets/308c4462-ca09-434f-89a6-3f6bac404be2\" align=\"top\"\u003e\u003cimg width=\"250\" alt=\"Screenshot of extension config area: example with demo\" src=\"https://github.com/ArchiveBox/archivebox-extension/assets/511499/82d6ae08-6327-45ef-a536-cb775ec58b41\" align=\"top\"\u003e\n5. ✅ *Test it out by right-clicking on any page and selecting `Save to ArchiveBox`, or by clicking the extension icon in the menubar.*  \n    \u003cimg width=\"400\" alt=\"Screenshot of right-clicking to add a page to ArchiveBox using extension\" src=\"https://github.com/ArchiveBox/archivebox-extension/assets/511499/6c0b8125-e1b9-4c64-b79a-c74a8d85c176\" align=\"top\"\u003e\u003cimg width=\"600\" alt=\"Screenshot of ArchiveBox server with added URL\" src=\"https://github.com/ArchiveBox/archivebox-extension/assets/511499/ab2dc48a-e2cd-4bef-aea3-553a91bc70c9\" align=\"top\"\u003e\n\n---\n\n## Development\n\n*✨ 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.*\n\nIf 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/).\n\n```bash\ngit clone https://github.com/ArchiveBox/archivebox-browser-extension\ncd archivebox-browser-extension/\n\n# There is no build step with v2.1.3 and above, the project uses vanilla ESM JS.\n# Simply load the entire directory as an unpacked extension in Chrome\n```\n\nLoad 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.\n\nPlease open an issue to discuss any proposed changes *before* starting work on any PRs.\n\n## Changelog\n\n- 2025-03 New Manifest v3 [Extension v2.1.3](https://github.com/ArchiveBox/archivebox-browser-extension/releases/tag/v2.1.3) Released\n- 2024-11 Development [started](https://github.com/ArchiveBox/archivebox-browser-extension/pull/31) on v2 extension with more advanced UI and tagging options\n- 2024-01 Extension repo moved from `tjhorner/archivebox-exporter` to `Archivebox/archivebox-browser-extension`\n- 2021-09 Extension offically supported by ArchiveBox v0.6.2, no longer needed to run `:dev` branch\n- 2021-07 Initial extension [published](https://github.com/ArchiveBox/ArchiveBox/issues/577#issuecomment-872915877) on Chrome and Mozilla web stores\n- 2021-06 [@tjhorner](https://github.com/tjhorner) [Created](https://github.com/ArchiveBox/ArchiveBox/issues/577) the initial `archivebox-exporter` extension\n\n---\n\n## Alternative Extensions for Archiving\n\nOther browser extensions that also do web archiving which may be a better fit if ArchiveBox doesn't suit your needs.\n\n- [ArchiveWeb.page](https://webrecorder.net/archivewebpage) (super high fidelity archiving extension by Webrecorder)\n- [SingleFile](https://github.com/gildas-lormeau/SingleFile) (a great extension for saving pages into a single `.html` file, built-in to ArchiveBox already)\n- [Hypothesis](https://web.hypothes.is/start/) (extension focused on annotating, but also supports archiving)\n- [Memex](https://memex.garden/) (another project focused on annotating that supports archiving)\n- [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)\n\n## Other ArchiveBox Helper Projects\n\nOther projects that help with ingest URLs into ArchiveBox from various sources.\n\n- https://github.com/layderv/archivefox (user-contributed extension for Firefox)\n- https://github.com/Gertje823/ArchiveboxTelegramBot (Telegram Bot to send URLs to ArchiveBox)\n- https://github.com/TheCakeIsNaOH/xbs-to-archivebox (Download your bookmarks from xBrowserSync, filter them, and save them into ArchiveBox)\n- https://github.com/emschu/archivebox-quick-add (golang utility to add links to ArchiveBox)\n- https://github.com/FracturedCode/archivebox-reddit (automatically back up saved Reddit comments, posts, etc. to ArchiveBox)\n- https://github.com/dbeley/reddit_export_userdata (older Python utility to archive reddit content to ArchiveBox)\n- https://github.com/jess-sol/reddit-exporter (export reddit data to ArchiveBox)\n- https://github.com/jonesd/archivebox-pinboard-tranformer (export links from pinboard to ArchiveBox)\n- https://github.com/agg23/archivebox-url-forwarder (older WebExtension to forward URLs to archivebox)\n\n---\n\n## License\n\nMIT License\n","funding_links":[],"categories":["JavaScript","TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArchiveBox%2Farchivebox-browser-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FArchiveBox%2Farchivebox-browser-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArchiveBox%2Farchivebox-browser-extension/lists"}