EarthReader-Web 0.2.0

Install

You can install Earth Reader for Web using pip:

$ pip install EarthReader-Web

Then you can use command earthreader.

$ earthreader -h

Repository

Repository is a directory to store data. It can be inside of Dropbox or Google Drive folder to be synchronized with other devices. You also can synchronize the repository directory using rsync.

If the path that doesn’t exist yet is passed to CLI repository path argument or EARTHREADER_REPOSITORY environment variable the new folder will be automatically created.

Standalone server

You can run Earth Reader for Web using its standalone server:

$ earthreader server /path/to/repository/dir
$ earthreader server -p 8080 /path/to/repository/dir  # listen to 8080 port
$ earthreader server -d /path/to/repository/dir  # debug mode

And then open http://localhost:<port>/ with your browser.

WSGI server

Earth Reader for Web is actually an ordinary WSGI-compliant web application, so you can run it using your preferred WSGI server e.g. Gunicorn, mod_wsgi. The WSGI endpoint is earthreader.web.app:app. Note that you can provide the path of repository by setting EARTHREADER_REPOSITORY environment variable.

Note that you should manually invoke earthreader crawl command when you run it using your preferred WSGI server while the standalone server (earthreader server command) automatically does it for you. We recommend you to register earthreader crawl command to your crontab.

For example, you can run it on Gunicorn:

$ export EARTHREADER_REPOSITORY=/path/to/repository/dir
$ gunicorn earthreader.web.app:app

Or you can attach Earth Reader to Apache with mod_wsgi like this:

<VirtualHost *:80>
  ServerName yourwebsite.com
  WSGIDaemonProcess earthreader user=www-data group=www-data threads=1
  WSGIScriptAlias / /var/wsgi/earthreader.wsgi

  <Directory /var/wsgi/>
     WSGIProcessGroup earthreader
     WSGIApplicationGroup %{GLOBAL}

     Order deny,allow
     Allow from all
     # We recommend you to use authorization for security.
     AuthType Basic
     AuthName "Private rss reader"
     AuthUserFile /var/wsgi/earthreader.htpasswd
     Require valid-user
  </Directory>
</VirtualHost>

#!/usr/bin/env python
#/var/wsgi/earthreader.wsgi
import sys
from earthreader.web.app import app as application

application.config.update(
    REPOSITORY='/path/to/repository/dir'
)

And open http://yourwebsite.com/ in your browser.

Crawler

You can manually crawl feeds as well via CLI:

$ earthreader crawl /path/to/repository/dir

Keyboard shortcuts

Vim-inspired keyboard shortcuts are also available:

• j/k: Older/newer entry.

• n/p: Next/previous subscription.

• o: Open entry in new tab.

• r: Refresh the feed.

• s: Star/unstar.

• u or m: Mark as unread.

• ?: This help message.

Links

Earth Reader

http://earthreader.org/

libearth

https://github.com/earthreader/libearth

Git repository (GitHub)

https://github.com/earthreader/web

Issue tracker (GitHub)

https://github.com/earthreader/web/issues

Mailing list

earthreader@librelist.com

List archive

http://librelist.com/browser/earthreader/

Continuous integration (Travis)

https://travis-ci.org/earthreader/web

Changelog