Portainer Templates logo

Portainer Templates

Readeck Readeck

Container

ProductivityBooks

Read-it-later app that saves the full text and images of web pages, with highlights, labels, collections, full-text search and e-book export. Source: https://codeberg.org/readeck/readeck

Configuration

Type
Container
Platform
linux
Image
codeberg.org/readeck/readeck:latest
Ports
8097:8000/tcp
Volumes
/readeck
Restart
unless-stopped

Template by NotAFlightRisk

Report issue

Notes

Open http://<your-host>:8097 and create your account. Whoever gets there first becomes the admin, and there are no open sign-ups after that, the admin adds users under Settings --> Users. The browser extension saves pages in one click. Readeck won't fetch pages on private addresses, so links to things on your LAN save without their content. The settings, generated secret key, SQLite database and every saved page live in the volume. Docs: readeck.org

Standalone Install

Select an install method, to see config/commands for deploying Readeck

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Readeck, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

Serve Readeck on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying readeck.example.com to http://readeck:8000

Add this to your Caddyfile

readeck.example.com {
	reverse_proxy http://readeck:8000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs readeck
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8097 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8097
  • Stop the other service, or pick a different host port. In 8097:8000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8097. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, readeck can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8097

Image won't pull

Test the pull directly on the host: docker pull codeberg.org/readeck/readeck:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect readeck --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Readeck runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Readeck needs bundled into one download. This template pulls codeberg.org/readeck/readeck:latest, which Docker fetches once and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Readeck's comes from codeberg.org, published by readeck.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Ports

A port is the door the app answers on. A mapping like 8097:8000 means it's reachable on port 8097 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8097 in a browser. It opens:

  • 8097:8000, likely the web interface

Volumes

A volume is where Readeck keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /readeck as a volume Docker manages for you

Restart policy

The restart policy here is unless-stopped, so Docker restarts Readeck after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Readeck sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container readeck. That's what you'll spot in the containers list and use in commands like docker logs readeck.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Readeck up. Add the template list to Portainer once, then deploying Readeck is a click rather than a wall of config.