Read your Internet article flow in one place with complete peace of mind and freedom.
- 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.
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
You can configure the server by setting environment variables:
||Service listen address|
||none||Metrics listen address|
||Database connection string|
||Authentication method ("mock", "proxy" or OIDC if URL)|
||none||External event broker URI for outgoing events|
||none||Sentry DSN URL for error reporting|
||Logging level (
||Plain text log output format if true (JSON otherwise)|
||Log output target (
You can also override these settings using program parameters.
readflow --help to see options.
You can access Web UI on http://localhost:8080/ui
The documentation can be found here: https://about.readlow.app/docs
You can explore the server API using GraphiQL endpoint: http://localhost:8080/graphiql
To be able to build the project you will need to:
$ git submodule init $ git submodule update
Then you can build the project using make:
make help to see other possibilities.
These amazing people have sponsored this project:
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.