Skip to content
WPTKPublic

About

A self-hosted RSS reader for one person: web app plus a Google Reader-compatible sync API (Reeder Classic, NetNewsWire). One container, one port.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

774 Commits

Folders and files

Repository files navigation

Kipple

When nobody's around, kipple reproduces itself.

Philip K. Dick, Do Androids Dream of Electric Sheep? (1968)

A self-hosted RSS reader. That I want to use.

CI Release License: Blue Oak 1.0.0 Container image

Kipple in a desktop browser: feeds on the left, a list of articles with thumbnails in the middle, and an article open on the right. Kipple on a phone: article cards with large photos, one per row, and a tab bar along the bottom.
Web app. Feeds on the left, the article list in the middle, the open article on the right. On a phone. Add Kipple to the home screen and it opens full screen, like an app.

Kipple is in beta. It is in daily use, and 1.0 follows more testing. CHANGELOG.md lists what shipped in each release.

What you get

  • Five ways to browse a feed: large lead images with an excerpt, a grid of photo cards, a plain list without pictures, email-style rows, or one line per title. Set it per device or per feed.
  • 20 color themes, with separate picks for day and night, and 11 bundled reading fonts.
  • Nested folders for organizing feeds.
  • Import feeds from your old reader and export them any time (OPML).
  • Search, saved searches, and keyword filters that mute, star, highlight or mark articles read.
  • Choose how many articles each feed keeps, from 50 to unlimited. Starred articles are never deleted.
  • Runs as a phone app, installed from your browser. Articles you have opened still read offline.
  • Syncs with RSS apps on your phone or computer.
  • Reading statistics and a yearly Wrapped summary, stored only in your own database.
  • Backup and restore are built in.
  • Designed for a single-user environment.

Install

Pull the image and start it. Replace <version> with the newest tag on the releases page (the latest tag exists from the first stable release).

docker run -d --name kipple --restart unless-stopped -p 127.0.0.1:1919:1919 -v kipple_data:/data ghcr.io/wptk/kipple:<version>

Open http://127.0.0.1:1919. The first screen creates your account, or restores a backup from another Kipple. The setup wizard after the account asks for your time zone, a theme, an OPML import from your old reader, a few starter feeds, and the address your other devices will use. Every step after the account can be skipped.

Until you create the account, anyone who can reach the port can. The command above publishes the port on 127.0.0.1 only, so only this machine can. Widen it after you have an account.

The deploy guide covers the compose file, reaching Kipple from your phone or over HTTPS, backups, upgrades, verifying the image signature and building from source.

Sync with other apps

Kipple can sync read and starred articles with RSS apps on your phone or computer. In the app, add a Google Reader compatible account with:

  • Server: your Kipple address plus /api/greader.php
  • User name: the one you chose during setup
  • Password: the API password. The last setup step shows it, and Settings, Account & Devices can make a new one.

What Kipple leaves out

These are left out on purpose, and requests for them are closed.

  • Native support for podcasts, audio and video. A media link in an article still opens.
  • Webhooks and other integrations with outside services.
  • Tags. Feeds live in folders, and articles can be starred.
  • AI features.
  • Notifications.
  • Social features. You can still share an article from the web app: it opens your device's share sheet, or copies the link.
  • Monitoring or analytics.*
  • More than one user.

* Kipple keeps reading statistics, but they live in your own database, only you see them, and nothing sends them anywhere.

Documentation

To report a bug, open an issue. To send a change, read CONTRIBUTING.md. Vulnerabilities go through SECURITY.md.

License

Blue Oak Model License 1.0.0: use, modify and share it, including commercially. Third-party licenses are in THIRD_PARTY_NOTICES.md.

About

A self-hosted RSS reader for one person: web app plus a Google Reader-compatible sync API (Reeder Classic, NetNewsWire). One container, one port.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages