Linux

Where Does Readeck Store Config and Articles?

Readeck keeps config.toml, the SQLite DB, and archived pages in one /readeck volume on Docker installs.

Last updated

Readeck puts everything in one place on purpose. The /readeck volume holds config.toml, the SQLite database, and saved article archives side by side. Migration becomes a single folder copy.

Bare-metal installs split the same files across /etc/readeck and /var/lib/readeck by convention. Docker keeps them together. Either way the database file and the archives must travel as a pair.

Where Readeck stores this, by platform

Linux
/readeck (inside container)

Single volume with config.toml, db.sqlite3, and archived bookmark files. Mount a named volume or host folder here.

Linux
/etc/readeck/config.toml + /var/lib/readeck

Conventional bare-metal split: config under /etc/readeck, working data under /var/lib/readeck. Same files, two roots.

Frequently asked questions

How do I back up Readeck?

Copy the whole /readeck volume: config.toml, db.sqlite3, and the bookmarks folder. One volume covers config and content, which is the point of the layout.

Can Readeck use Postgres?

Set READECK_DATABASE_SOURCE to a Postgres URL. SQLite stays the recommended default for single instances. Never put the SQLite file on NFS or CIFS.

Where does bare-metal Readeck read config?

Create /etc/readeck/config.toml and run with WorkingDirectory /var/lib/readeck. The service file in the deployment docs shows the exact unit.

Notice an outdated path? Let us know.