Readeck¶

License: AGPLv3

This guide is tested with Readeck 0.22.3 on Uberspace 8.0.75. We can't guarantee it to work with newer versions.

Readeck is an open source bookmark manager and a read later tool. It allows you to save the content of websites that you like and that you want to keep for as long as possible.

Note

For this guide you should be familiar with the basic concepts of:

Installation¶

Create a new directory, enter the directory you just created, download the latest version, rename the file and make the binary executable:

[isabell@moondust ~]$ mkdir ~/readeck
[isabell@moondust ~]$ cd ~/readeck
[isabell@moondust readeck]$ wget "https://codeberg.org/readeck/readeck/releases/download/0.22.3/readeck-0.22.3-linux-amd64"
[isabell@moondust readeck]$ mv readeck-0.22.3-linux-amd64 readeck
[isabell@moondust readeck]$ chmod +x readeck

To create all the necessary files, you should start Readeck for a moment:

[isabell@moondust readeck]$ ./readeck serve
{"time":"2026-05-04T22:49:51.772357828+02:00","level":"INFO","msg":"workers started","num":20}
{"time":"2026-05-04T22:49:51.772645841+02:00","level":"INFO","msg":"server started","addr":"tcp://127.0.0.1:8000","url":"http://localhost:8000/"}

Now press Ctrl+C to stop it again:

^C{"time":"2026-05-04T22:50:01.021343053+02:00","level":"INFO","msg":"shutting down..."}
{"time":"2026-05-04T22:50:01.02157081+02:00","level":"INFO","msg":"stopping server..."}
{"time":"2026-05-04T22:50:01.02168968+02:00","level":"INFO","msg":"server stopped"}
{"time":"2026-05-04T22:50:01.021734481+02:00","level":"INFO","msg":"stopping workers..."}
{"time":"2026-05-04T22:50:01.02178276+02:00","level":"INFO","msg":"workers stopped"}

The directory data (with further content) and the file config.toml have now been created in the directory ~/readeck.

Configuration¶

Configure Readeck¶

Note

Visit the official documentation to see all available settings.

The following setting must be adjusted in the ~/readeck/config.toml:

We only need warnings in our logs. Change in [main]:

log_level = "warn"

in [server] adjust the host setting:

host = "0.0.0.0"

Just below that line, add the following:

use_x_forwarded_proto = true

Readeck has a "forgot password" function, but this will only appear if the email section has been configured in the config.toml file. So if you want this, add the following:

[email]
host = "moondust.uberspace.de"
port = 587
username = "Your email address, including the domain"
password = "Your password for the email address"
encryption = "starttls"
from = "isabell@uber.space"

Setup Systemd¶

Create a service:

[isabell@moondust ~]$ uberspace service add readeck "$HOME/readeck/readeck serve" --workdir "$HOME/readeck"

Setup Web Backend¶

Note

The default port for Readeck is 8000.

To make the application accessible from the outside, configure a web backend:

[isabell@moondust ~]$ uberspace web backend add / port 8000 --force
OK: Added webbackend '/' to your Asteroid

Readeck should now be running, and you can find it at https://isabell.uber.space.

Updates¶

Note

Check the update feed regularly.

To update the software, download the latest version, replace the executable file, and restart the service (systemctl --user restart readeck.service).