Readeck

Save articles and web pages to read later.

Choose your deployment and the way you want to use Selfhost. The instructions below follow that choice.

Deployment Use Selfhost with

Set up Readeck

Editable Compose files in your own directory.

Create the first administrator through Readeck.
Set the public URL, allowed hosts and SMTP settings as needed.

selfhost app --directory ./readeck init readeck

Initialization writes portable files and does not start the app. Review compose.yaml, the private .env and any files in files/, then start it:

selfhost app --directory ./readeck start

No Selfhost dashboard or background service is needed. You can also start these files directly:

cd readeck
docker compose -f compose.yaml up -d

Connect an existing installation

Use Existing apps → Link an app in the dashboard, or the CLI’s existing-app commands. Choose Readeck, its URL and, optionally, its exact Docker container on a connected server.

Save existing.json with your app URL. Add server_id and container for container inspection and actions.

{
  "profile": "readeck",
  "name": "Readeck",
  "url": "https://app.example.com"
}

selfhost existing link --file existing.json
selfhost existing list
selfhost existing inspect EXISTING_ID

Linking enables the existing-app profile’s supported inspection and actions. It does not import Compose or attach the new-deployment settings and onboarding profiles described below.

Existing app commands, permissions and unlinking

Before configuring integrations

The named SELFHOST OIDC provider keeps provisioning disabled until you choose to allow new accounts.
Provider URL changes can change upstream identity association. Review existing account links first.
The native config.toml and article storage remain part of the data backup.

Readeck integrations

Compose service: readeck. These operations use the profile saved when this deployment is created.

OIDC provisioning does not grant administration rights. Existing providers in config.toml remain configured; the SELFHOST provider is a separate named entry.

Native settings

Changes use the app’s Compose environment. Unrelated settings are preserved.

Supported fields (13)

Public URL public-url: string
Allowed HTTP hosts allowed-hosts: Comma-separated exact hostnames. string
Trusted proxies trusted-proxies: Comma-separated CIDRs. string
Log level log-level: stringChoices: DEBUG, INFO, WARN, ERROR
SMTP host mail-host: string
SMTP username mail-user: string
SMTP password mail-password: secret
Sender email mail-from: string
Identity provider name oidc-name: string
Identity provider issuer oidc-url: string
OIDC client ID oidc-client: string
OIDC client secret oidc-secret: secret
Create accounts on first OIDC login oidc-provision: stringChoices: true, false

Save a JSON map of the field IDs you want to change as changes.json. Replace FIELD_ID with an ID from the supported fields above, and use its declared value type. Review the plan and replace REVIEWED_REVISION with the revision it returns.

{
  "FIELD_ID": "YOUR_VALUE"
}

selfhost app --directory ./readeck config readeck
selfhost app --directory ./readeck plan readeck changes.json
selfhost app --directory ./readeck apply readeck changes.json --revision REVIEWED_REVISION

Saved changes need service recreation to become active. Existing interpolated environment values stay under your control in .env or Compose.

Identity provider login

Selfhost can register a client with a supported provider and configure this app. Callback path: /login/oidc.

No administrator role is assigned by Selfhost. Check the app’s first-login policy and retain a local recovery account.

Save connection.json and replace the URLs. Supply SELFHOST_IDP_TOKEN privately in your shell.

{
  "provider": "zitadel",
  "issuer": "https://identity.example.com",
  "app_url": "https://app.example.com",
  "name": "Readeck"
}

selfhost app --directory ./readeck connect-account readeck connection.json
selfhost app --directory ./readeck connect-plan readeck connection.json
selfhost app --directory ./readeck connect readeck connection.json --revision REVIEWED_REVISION

Test sign-in in a separate browser session. HTTPS domains and HTTP loopback development origins are supported by Selfhost; the chosen app and provider must also accept the resulting callback. Provider permissions, localhost and recovery.

Database placement

This recipe supports postgres. Workspace projects can choose a dedicated database, a shared source with a separate database and account, or an existing external database before their first start.

Standalone directories use the generated Compose and environment files directly. Configure the database there before first start. Selfhost’s source provisioning commands belong to workspace projects and are optional.

Database setup, CLI commands and backups

App configuration reference

Versions and updates

This deployment uses the following images. Existing projects retain their saved recipe and images. A new catalogue version does not silently update them.

readeck: codeberg.org/readeck/readeck:0.23.4

Review compatibility and back up app data before an update. Choose an image version and review the change.

Keep control of your setup

Selfhost remains optional. Your app runs using ordinary Compose files, its own settings and persistent data. Keep the Compose project name and volumes to preserve storage. Configuration exports and setting backups do not include application data.

Standalone CLI guide · Backups and removal · Readeck documentation