Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ncarlier/nunux-reader
The super-fast-minimalist-nosql-opensource Google Reader revival.
https://github.com/ncarlier/nunux-reader
Last synced: about 24 hours ago
JSON representation
The super-fast-minimalist-nosql-opensource Google Reader revival.
- Host: GitHub
- URL: https://github.com/ncarlier/nunux-reader
- Owner: ncarlier
- License: gpl-3.0
- Archived: true
- Created: 2013-08-19T09:18:12.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-04-27T10:24:27.000Z (over 5 years ago)
- Last Synced: 2024-08-01T12:27:51.264Z (3 months ago)
- Language: HTML
- Homepage: http://reader.nunux.org/
- Size: 8.69 MB
- Stars: 66
- Watchers: 8
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - ncarlier/nunux-reader - The super-fast-minimalist-nosql-opensource Google Reader revival. (HTML)
- awesome-starred - ncarlier/nunux-reader - The super-fast-minimalist-nosql-opensource Google Reader revival. (others)
README
# NUNUX Reader
The super-fast-minimalist-nosql-opensource Google Reader revival.
---
### :warning::warning::warning:This project is no longer maintained:warning::warning::warning:
**Please consider to use another news reader such as [readflow](https://readflow.app)!**
---
Features:
* Faster than light thanks to Redis and Node.js
* Dynamic GUI thanks to AngularJS
* Responsive Web Design
* Login with Google OAuth2 or Mozilla Persona
* OPML import/export
* Manage subscriptions
* Save articles in [Nunux Keeper](http://keeper.nunux.org), Pocket or Dropbox
* Keep article as not read
* Powerfull reactive aggregator daemon
* Support of PubSubHubbud
* RESTFul JSON [API](http://reader.nunux.org/doc/)
* 100% Javascript!
## Installation guide with Docker (the recommended way)
### Prerequisites
* [docker](http://www.docker.com/)
### Start the Redis server
docker run --name redis -d redis
### Configuration
You can configure the server by setting environment variables:
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_PORT` | `3000` | Server port |
| `APP_REALM` | `http://localhost` | Public URL used for callbacks (AuthN and PSHB) |
| `APP_REDIS_URL` | `redis://localhost:6379` | Database URI |
| `APP_DAYS_TO_KEEP` | `30` | Number of days to keep an article in the database |
| `APP_PSHB_ENABLED` | `false` | Feature flag to activate PubSubHubBud support |
| `APP_AUTO_GRANT_ACCESS` | `true` | Feature flag to activate automatic user registration |
| `APP_SESSION_SECRET` | `NuNUXReAdR_` | Secret key to encode the session cookie |
| `APP_ADMIN` | empty | Comma-separated list of user id that have the admin role |
| `APP_EMBEDDED_DAEMONS` | empty | List of daemon embedded with the server (not recommended for production) |
#### Authentication configuration
Configuration needed to login with Google:
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_GOOGLE_KEY` | empty | Google OAuth key |
| `APP_GOOGLE_SECRET` | empty | Google OAuth secret key |
Configuration needed to delegate authentication to an upstream proxy (NGINX,
Apache, Traefik, ...):
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_AUTH_PROXY_HEADER` | empty | Header's name used to extract username (ex: `x-webauth-user`)|
**Example of configuration with NGINX:**
```
server {
listen 80;
server_name nunux-reader;
access_log /var/log/nginx/nunux-reader.access.log;
auth_basic_user_file /etc/nginx/passwd;
auth_basic "Restricted";
location / {
proxy_set_header X-WEBAUTH-USER $remote_user;
proxy_pass http://127.0.0.1:3000;
allow 127.0.0.1;
deny all;
satisfy any;
}
}
```
#### Archiver configuration
Configuration needed to save articles into Pocket:
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_POCKET_KEY` | empty | Pocket key |
Configuration needed to save articles into Dropbox:
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_DROPBOX_KEY` | empty | Dropbox key |
| `APP_DROPBOX_SECRET` | empty | Dropbox secret |
Configuration needed to save articles into
[Nunux Keeper](http://keeper.nunux.org):
| Variable | Default | Description |
|----------|---------|-------------|
| `APP_KEEPER_V2_URL` | empty | Nunux Keeper API URL |
| `APP_KEEPER_V2_KEY` | empty | Nunux Keeper key |
| `APP_KEEPER_V2_SECRET` | empty | Nunux Keeper secret |
### Start the Web Site
Configure the application according your needs by editing "./etc/default/dev.ev" file.
(see ./etc/default/dev.env in this repository for more details)
Then start the Web Server:
```
make start
```
OR
```
docker run \
--rm \
--name reader-server \
--link redis:db \
--env-file ./etc/default/dev.env \
-p 3000:3000
-i -t \
ncarlier/reader
```
Go to http://localhost:3000 and the magic happens.
### Start the feed updater daemon
This daemon is responsible to fetch articles of the registered subscriptions.
```
docker run \
--rm \
--name reader-feed-updater \
--link redis:db \
--env-file ./etc/default/dev.env \
-i -t \
ncarlier/reader run feed-updater
```
### Start the timeline updater daemon
This daemon is responsible to update user's timelines.
```
docker run \
--rm \
--name reader-timeline-updater \
--link redis:db \
--env-file ./etc/default/dev.env \
-i -t \
ncarlier/reader run timeline-updater
```
## Installation guide from scratch (the -not so- hard way)
### Prerequisites
* [git](http://git-scm.com/)
* [nodejs](http://nodejs.org/) v0.10.x
* [redis](http://redis.io/) v2.2
#### Install Git, Node.JS and Redis (on Debian)
```
sudo aptitude install git nodejs redis-server
```
#### Install Grunt
```
sudo npm install -g grunt-cli
```
### Install Web Site
```
cd /opt_
git clone [email protected]:ncarlier/nunux-reader.git
cd nunux-reader
npm install
```
### Run Web Site
```
#!/bin/sh
# See etc/default/dev.env for environment configuration.
source ./etc/default/dev.env
npm start 2>&1 >> app.log
```
### Jobs
* **clean-db.js**: Clean database (aka remove old articles). Usage:
```
./server/daemon/db-cleaner.js -v --days 30
```
* **feed-updater.js**: Update feeds content. It's a daemon. Use CTRL+C to stop. Usage:
```
./server/daemon/feed-updater.js -v
```
* **timeline-updater.js**: Update users timelines. It's a daemon. Use CTRL+C to stop. Usage:
```
./server/daemon/timeline-updater.js -v
```
------------------------------------------------------------------------------
NUNUX Reader
Copyright (c) 2013 Nicolas CARLIER (https://github.com/ncarlier)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
------------------------------------------------------------------------------