Skip to content
Read the Internet with complete peace of mind and freedom.
TypeScript Go CSS JavaScript Makefile HTML Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autogen/db/postgres
docs
landing
makefiles @ c249aaa
pkg
scripts
ui
.dockerignore chore(): finalize project packaging Apr 30, 2019
.editorconfig
.gitignore
.gitmodules
.travis.yml
Dockerfile
LICENSE
Makefile
README.md
docker-compose.dev.yml
docker-compose.test.yml
docker-compose.yml
generate.go
go.mod
go.sum
install.sh chore(): finalize project packaging Apr 30, 2019
main.go
readflow.svg
screenshot.png

README.md

readflow

Build Status Go Report Card Docker pulls

Read your Internet article flow in one place with complete peace of mind and freedom.

Logo

Features

  • Read articles from anywhere in one place.
  • Save articles for offline reading.
  • Save articles to external services (Keeper, Wallabag, Webhooks...).
  • Create categories and classify new articles automatically thanks to a customizable rule engine.
  • Receive notifications when new articles are to be read.
  • Good user experience on mobile devices.
  • No tracking and no publicity.

Installation

Run the following command:

$ go get -v github.com/ncarlier/readflow

Or download the binary regarding your architecture:

$ sudo curl -s https://raw.githubusercontent.com/ncarlier/readflow/master/install.sh | bash

Or use Docker:

$ docker run -d --name=readflow ncarlier/readflow

Configuration

You can configure the server by setting environment variables:

Variable Default Description
APP_LISTEN :8080 Service listen address
APP_LISTEN_METRICS none Metrics listen address
APP_DB postgres://postgres:testpwd@localhost/reader_test Database connection string
APP_AUTHN https://login.nunux.org/auth/realms/readflow Authentication method ("mock", "proxy" or OIDC if URL)
APP_BROKER none External event broker URI for outgoing events
APP_PUBLIC_URL https://api.readflow.app Public URL
APP_SENTRY_DSN none Sentry DSN URL for error reporting
APP_LOG_LEVEL info Logging level (debug, info, warn or error)
APP_LOG_PRETTY false Plain text log output format if true (JSON otherwise)
APP_LOG_OUTPUT stdout Log output target (stdout or file://sample.log)

You can also override these settings using program parameters. Type readflow --help to see options.

UI

You can access Web UI on http://localhost:8080/ui

Screenshot

Documentation

The documentation can be found here: https://about.readlow.app/docs

GraphQL API

You can explore the server API using GraphiQL endpoint: http://localhost:8080/graphiql

Development

To be able to build the project you will need to:

  • Install makefiles external helpers:
    $ git submodule init
    $ git submodule update

Then you can build the project using make:

$ make

Type make help to see other possibilities.

Bakers

These amazing people have sponsored this project:

Code Lutin

Donate


License

Readflow is provided under the MIT License.

The MIT License (MIT)
Copyright (c) 2019 Nicolas Carlier
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.