aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 3bf3a9b37b335af3105860147ffb149487ee436b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# Archiveror

[![Build Status](https://travis-ci.org/rahiel/archiveror.svg?branch=master)](https://travis-ci.org/rahiel/archiveror)
[![License](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://github.com/rahiel/archiveror/blob/master/LICENSE.txt)

Archiveror is a browser extension that archives webpages by submitting them to
[archive.is][], [archive.org][] and other archiving services. These archives are
publicly available, so you then have a backup that you can refer to in case the
original falls prey to [link rot][].

Archiveror also preserves your bookmarks by automatically archiving them in the
background. Its icon changes when you visit a bookmark it has archived, clicking
on it shows the archive links. Archiving of bookmarks happens when you make a
new bookmark and when you open an old bookmark. This can be disabled.

You can manually archive webpages by clicking on the icon, using the Alt+Shift+Y
hotkey (configurable), via the page's right click context menu, or by
right-clicking on links on a page. The URL for the archive is then copied to
your clipboard, so you can easily paste the link for references and citations.

Happy archiving!

[archive.is]: https://archive.is
[archive.org]: https://archive.org
[link rot]: https://en.wikipedia.org/wiki/Link_rot

## Archiving Services

Archiveror supports several online archiving service. When clicking on the icon,
you'll see an "Archive Now" button. You can select which archiving services to
use when you click this button at the options, there you can also select
multiple services to archive a single page at multiple web archives.

- [**archive.is**](https://archive.is), launched in 2012. Blocks (some)
  advertising and (user tracking) JavaScript. Links:
  [Example](https://archive.is/N0yex), [FAQ][faq-archive.is],
  [Wikipedia][wiki-archive.is].
- [**archive.org**](https://archive.org/web/), launched in 2001. Better known as
  the [Wayback Machine][]. Respects [robots.txt][robot] so it cannot archive all
  webpages. Links:
  [Example](https://web.archive.org/web/20160420095454/http://physics.weber.edu/schroeder/md/),
  [FAQ][faq-archive.org], [Wikipedia][wiki-archive.org].
- [**perma.cc**](https://perma.cc/), launched in 2013. Founded by the Harvard
  Law School Library. Provides accounts to manage archived links. Free accounts
  can only create 10 archives. Links:
  [Example](https://perma.cc/M8Q2-B8FY), [FAQ][faq-perma].
- [**webcitation.org**](http://www.webcitation.org), launched in 1997, respects
  robots.txt. You need to set an email address at the options to use it. Has a
  focus on academic users. Links:
  [Example](http://www.webcitation.org/6guJcxnyr), [FAQ][faq-webcite],
  [Wikipedia][wiki-webcite].

[robot]: https://en.wikipedia.org/wiki/Robots_exclusion_standard
[faq-archive.is]: https://archive.is/faq
[faq-archive.org]: https://archive.org/about/faqs.php#The_Wayback_Machine
[faq-perma]: https://perma.cc/docs/faq
[faq-webcite]: https://www.webcitation.org/faq
[wiki-archive.is]: https://en.wikipedia.org/wiki/Archive.is
[wiki-archive.org]: https://en.wikipedia.org/wiki/Internet_Archive
[wiki-webcite]: https://en.wikipedia.org/wiki/WebCite
[wayback machine]: https://en.wikipedia.org/wiki/Wayback_Machine

## Local Saving

Archiveror also makes local copies of webpages. It saves one webpage in a single
[MHTML][] file. Save pages manually by either clicking the button or by pressing
Ctrl+Shift+S. The filenames end with the UTC date and time of when the archive
was made, and with the first 4 bytes of the SHA-256 hash of the archive.

To enable local archiving of bookmarks, right click the Archiveror button, go to
the options and then select "MHTML" at the "Bookmarks" section. With this option
enabled your bookmarks will be saved in your Downloads directory following your
bookmark structure. If you move your bookmarks around, Archiveror will mirror
your changes and likewise move your local archives. For this to work you need to
check "Allow access to file URLs" at the extensions page. Go to your extensions
and enable it: <https://i.imgur.com/ahrfe3M.png>.

Local saving is currently only available for Chromium, vote
for [this bug][1261339] if you want this feature on Firefox. Alternatively
consider the [Save Page WE][] add-on.

[MHTML]: https://en.wikipedia.org/wiki/MHTML
[1261339]: https://bugzilla.mozilla.org/show_bug.cgi?id=1261339
[Save Page WE]: https://addons.mozilla.org/firefox/addon/save-page-we/

## Installation

* [Chromium](https://chrome.google.com/webstore/detail/archiveror/cpjdnekhgjdecpmjglkcegchhiijadpb)
* [Firefox](https://addons.mozilla.org/firefox/addon/archiveror/)

## Credits

* The [floppy disk icon][floppy] is by the
  artist [sixsixfive](https://sixsixfive.deviantart.com/) and was generously
  released into the public domain.
* This extension would not be possible without the free archiving services
  provided by <https://archive.is>, <https://archive.org>, <https://perma.cc/>
  and <http://www.webcitation.org>.
* The essay [Archiving URLs](https://www.gwern.net/Archiving-URLs) by Gwern
  Branwen served as inspiration for this add-on.

[floppy]: https://openclipart.org/detail/211780/matt-icons_media-floppy-by-sixsixfive-211780