Update README.md

This commit is contained in:
Nick Sweeting 2017-07-01 12:15:09 -05:00 committed by GitHub
parent 2b0e0f746e
commit c6fd9ce055

View file

@ -8,8 +8,9 @@
(Your own personal Way-Back Machine) [DEMO: sweeting.me/pocket](https://home.sweeting.me/pocket) (Your own personal Way-Back Machine) [DEMO: sweeting.me/pocket](https://home.sweeting.me/pocket)
Save an archived copy of all websites you star. Save an archived copy of all websites you star (the actual *content* of the sites, not just the list of bookmarks).
Outputs browsable html archives of each site, a PDF, a screenshot, and a link to a copy on archive.org, all indexed in a nice html file.
Outputs browsable static html archives of each site, a PDF, a screenshot, and a link to a copy on archive.org, all indexed in a nice html file.
![](screenshot.png) ![](screenshot.png)
@ -88,18 +89,20 @@ format strings (not a proper templating engine like jinja2), which is why the CS
## Publishing Your Archive ## Publishing Your Archive
The archive is suitable for serving on your personal server, you can upload the The archive produced by `./archive.py` is suitable for serving on any provider that
archive to `/var/www/pocket` and allow people to access your saved copies of sites. can host static html (e.g. github pages!).
You can also serve it from a home server or VPS by uploading the archive folder
to your web directory, e.g. `/var/www/pocket` and configuring your webserver.
Just stick this in your nginx config to properly serve the wget-archived sites: Here's a sample nginx configuration that works to serve archive folders:
```nginx ```nginx
location /pocket/ { location /pocket/ {
alias /var/www/pocket/; alias /var/www/pocket/;
index index.html; index index.html; # show the main index.html by default
autoindex on; autoindex on; # allow people to see a directory listing when clicking on "the Files" links
try_files $uri $uri/ $uri.html =404; try_files $uri $uri/ $uri.html =404; # append .html to links before 404ing in order to reach sites that wget appended .html to
} }
``` ```