Readeck for Cloudron

Readeck is a self-hosted read-later and web archiving application. Save a link and Readeck fetches the page, strips the navigation, ads and cookie banners, and keeps a clean copy of the article — text and images — in its own archive. The saved copy stays readable even after the original goes behind a paywall, changes, or disappears.

This is an unofficial Cloudron community package for Readeck. The package version and the Readeck version are independent — see CHANGELOG.

What it does

• Article extraction — pages are reduced to readable text with the images kept, stored as a self-contained archive per bookmark.
• Full-text search — searches the article body, not just titles and URLs, using SQLite FTS5 built into the application. No separate search engine to run or forget to configure.
• Labels and collections — organise bookmarks by label, or define collections as saved filters that update themselves.
• Highlights and annotations — mark passages and attach notes as you read.
• E-reader delivery — send any article to a Kindle or Kobo as EPUB, or download the EPUB directly.
• Videos and pictures — bookmarks are also handled for video pages and image posts, not only articles.
• Import — bring in existing bookmarks from Pocket, Wallabag, Instapaper, Omnivore, Zotero, Linkding, CSV or plain text.
• Browser extensions and mobile apps — official Firefox and Chrome extensions, plus iOS and Android applications, all connect to this instance.
• API — a documented REST API with per-application tokens, available in-app under Profile.

First login

Username admin, password changeme, as stated in the post-install message. Change it immediately under Profile → Password.

The initial user is created only on first run, guarded by /app/data/.initialized. That guard is load-bearing: readeck user updates an existing user rather than failing, so without it every restart would silently reset the admin password back to the packaged default.

Authentication

This package uses Readeck's own user management. Cloudron SSO (OIDC/LDAP) is not available. Readeck does ship multi-factor authentication, enabled per user under Profile.

Storage

Everything Readeck writes — the database, the article archives, the extraction scripts — lives under the app's data directory, so Cloudron's backups cover the full installation with no extra configuration. The database is SQLite; there is no external database to provision.

Email

Password recovery and share-by-email are wired to Cloudron's sendmail addon. Share-by-email is what delivers an article to a Kindle or Kobo as EPUB — without mail configured, that option disappears from the UI and the route returns 403.

Developer

Releasing a new version.

1. Bump the versions

• Dockerfile — the FROM codeberg.org/readeck/readeck:<tag> tag, and upstreamVersion in CloudronManifest.json. Never :latest.
• version in CloudronManifest.json — must be higher than anything already in CloudronVersions.json.
• CHANGELOG — add a block at the top. It is shown as the update description in the app store.

2. Build and push the image

Runs on the remote build service, so architecture does not matter. The repository is remembered after the first run.

cloudron build --repository ghcr.io/fengchang/readeck-cloudron
cloudron build info

3. Add the version

Appends an entry to CloudronVersions.json from the manifest and the current build.

cloudron versions add --state published
cloudron versions verify

Use --state testing to stage without releasing, then cloudron versions update --version <version> --state published. Withdraw with cloudron versions revoke --version <version>.

4. Commit

Last, so the generated CloudronVersions.json is included.

git add -A
git commit -m "Update Readeck to <upstream version>"
git push

Licence

Readeck is free software under the AGPL-3.0. This Cloudron package is an unofficial community package with no affiliation to the Readeck project.