ArchiveBox/README.md
Nick Sweeting afff21271d formatting
2017-05-05 05:21:35 -04:00

75 lines
2.6 KiB
Markdown

# Pocket Stream Archive
(Your own personal Way-Back Machine)
Save an archived copy of all websites you star using Pocket, indexed in an html file.
![](screenshot.png)
## Quickstart
**Dependencies:** Google Chrome headless, wget
```bash
brew install Caskroom/versions/google-chrome-canary
brew install wget
# OR on linux
wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
apt update; apt install google-chrome-beta
```
**Usage:**
1. Download your pocket export file `ril_export.html` from https://getpocket.com/export
2. Download this repo `git clone https://github.com/pirate/pocket-archive-stream`
3. `cd pocket-archive-stream/`
4. `./archive.py ~/Downloads/ril_export.html`
It produces a folder `pocket/` containing an `index.html`, and archived copies of all the sites,
organized by timestamp. For each sites it saves:
- wget of site, e.g. `en.wikipedia.org/wiki/Example.html` with .html appended if not present
- `sreenshot.png` 1440x900 screenshot of site using headless chrome
- `output.pdf` Printed PDF of site using headless chrome
## Publishing Your Archive
The pocket archive is suitable for serving on your personal server, you can upload the pocket
archive to `/var/www/pocket` and allow people to access your saved copies of sites.
Just stick this in your nginx config to properly serve the wget-archived sites:
```nginx
location /pocket/ {
alias /var/www/pocket/;
try_files $uri $uri/ $uri.html =404;
}
```
Make sure you're not running any content as CGI or PHP, you only want to serve static files!
Urls look like: `https://sweeting.me/pocket/archive/1493350273/en.wikipedia.org/wiki/Dining_philosophers_problem`
## Info
This is basically an open-source version of [Pocket Premium](https://getpocket.com/).
I got tired of sites I saved going offline or changing their URLS, so I started
archiving a copy of them locally now, similar to The Way-Back Machine provided
by [archive.org](https://archive.org).
Now I can rest soundly knowing important articles and resources I like wont dissapear off the internet.
[sweeting.me/pocket](https://home.sweeting.me/pocket)
## Security WARNING
Hosting other people's site content has security implications for your domain, make sure you understand
the dangers of hosting other people's CSS & JS files on your domain. It's best to put this on a domain
of its own to slightly mitigate CSRF attacks.
It might also be prudent to blacklist your archive in your `robots.txt` so that search engines dont index
the content on your domain.