Welcome!
Thank you for your interest; this page will guide you through the installation process. I hope you enjoy using Readeck as much as I enjoy building it!
User Documentation
The User Documentation is embedded in Readeck so it's easy to access and always up-to-date.
You can, however, read the user documentation in the code repository if you'd like to have a peek on Readeck before installation.
Installation Requirements
Readeck consists of a single executable file with no dependencies. Any common computer you have around is probably more than capable of running the app.
Here are the resources needed:
- Operating System: Linux, FreeBSD, MacOS or Windows.
- CPU: Anything than can run the Operating Systems above.
- Memory: 512 MB. — It uses less than that but can peak when processing content's images.
- Storage: 200 MB would already take you a long way. You can count about 300kb for each bookmark you save.
Tip
Readeck will perform well enough on the old RaspberryPi 2 you forgot in a drawer.
Installation
With Docker or Podman
Readeck can easily run in a container using docker or podman. For a quick install, here's the docker command:
docker run --rm -ti -p 8000:8000 -v readeck-data:/readeck codeberg.org/readeck/readeck:latest
Tip
This will create a volume readeck-data that contains the database and the bookmark files. You can, of course, mount a folder as a volume if you prefer.
You can find all the released Readeck images on https://codeberg.org/readeck/-/packages/container/readeck/latest.
Binary file installation
Readeck is distributed as a single binary file. Using it is almost as straightforward as a container.
Open a terminal and go to a newly created directory:
mkdir -p readeck-install
cd readeck-install
Download the file matching your system and name it readeck (or readeck.exe on Windows).
For example, on a standard Linux system with an Intel or AMD CPU, you can download the latest release this way:
wget -O readeck https://codeberg.org/readeck/readeck/releases/download/0.15.3/readeck-0.15.3-linux-amd64
chmod a+x readeck
Launch Readeck with the serve argument:
./readeck serve
First time launch
Once Readeck has started, it is accessible on:
http://localhost:8000/
Upgrade
A simple process
The upgrade consists of swapping the executable or container image by the latest one and restart Readeck. The upgrade process, if any, runs when you restart the server.
Upgrading the container version
This is the easiest; run:
docker pull codeberg.org/readeck/readeck:latest
And then restart the container running the image.
Upgrading the binary release
Stop Readeck, Download the latest release and replace the currently running binary on your server. Then start Readeck.