Readeck
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.
License
All relevant legal information can be found here:
Installation
Create a new directory, enter the directory you just created, download the latest version, rename the file and make the binary executable:
Note
Replace 0.15.4 with the version of the latest release.
[isabell@stardust ~]$ mkdir ~/readeck
[isabell@stardust ~]$ cd ~/readeck
[isabell@stardust readeck]$ wget "https://codeberg.org/readeck/readeck/releases/download/0.15.4/readeck-0.15.4-linux-amd64"
[isabell@stardust readeck]$ mv readeck-0.15.4-linux-amd64 readeck
[isabell@stardust readeck]$ chmod +x readeck
[isabell@stardust readeck]$
To create all the necessary files, you should start Readeck for a moment:
[isabell@stardust readeck]$ ./readeck serve
INFO[0000] workers started
INFO[0000] server started url="http://localhost:8000/"
Now press Ctrl+C to stop it again:
^CINFO[0174] shutting down...
INFO[0174] stopping server...
INFO[0174] server stopped
INFO[0174] stopping workers...
INFO[0174] workers stopped
[isabell@stardust readeck]$
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:
host = "0.0.0.0"
Just underneath that line, add
use_x_forwarded_proto = true
As a lot of data is written to the log in the standard configuration, it may be sufficient to select a different setting here:
log_level = "warning"
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:
Warning
Replace stardust with your hostname, isabell with your username and insert the correct values for username and password!
[email]
host = "stardust.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 daemon
Create ~/etc/services.d/readeck.ini with the following content:
[program:readeck]
directory=%(ENV_HOME)s/readeck/
command=%(ENV_HOME)s/readeck/readeck serve
autostart=yes
autorestart=yes
startsecs=30
After creating the configuration, tell supervisord to refresh its configuration and start the service:
[isabell@stardust ~]$ supervisorctl reread
SERVICE: available
[isabell@stardust ~]$ supervisorctl update
SERVICE: added process group
[isabell@stardust ~]$ supervisorctl status
SERVICE RUNNING pid 26020, uptime 0:03:14
[isabell@stardust ~]$
If it’s not in state RUNNING, check your configuration.
Setup web backend
Note
The default port for Readeck is 8000.
To make the application accessible from the outside, configure a web backend:
[isabell@stardust ~]$ uberspace web backend set / --http --port <port>
Set backend for / to port <port>; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[isabell@stardust ~]$
Warning
Replace isabell with your username!
If Readeck is running, you can now find the website at https://isabell.uber.space.
Updates
Note
Check the Codeberg release page regularly to stay informed about the newest version.
To update the software, download the latest version, replace the executable file and restart the daemon (supervisorctl restart readeck).
Tested with Readeck 0.15.4, Uberspace 7.16.2
Written by: no-one <https://github.com/no-one>