Skip to content
Klutch.sh Docs

Deploying Readeck

Introduction

Readeck is a modern, self-hosted read-it-later application and bookmark manager. Built with Go and featuring a clean, responsive interface, Readeck allows you to save web articles, organize them with labels and collections, and read content in a distraction-free environment.

Key features of Readeck include:

  • Article Saving: Save web pages with full content extraction
  • Clean Reading: Distraction-free reading experience
  • Collections: Organize bookmarks into collections
  • Labels/Tags: Categorize content with flexible tagging
  • Full-Text Search: Search across all saved content
  • Offline Reading: Access saved articles without internet
  • Browser Extensions: Quick save from Chrome and Firefox
  • API Access: RESTful API for integrations
  • EPUB Export: Export articles as ebooks
  • Lightweight: Single binary with minimal dependencies

This guide walks through deploying Readeck on Klutch.sh using Docker and setting up your personal bookmark manager.

Prerequisites

Before deploying Readeck on Klutch.sh, ensure you have:

Deploying Readeck on Klutch.sh

    Create Your Dockerfile

    Create a Dockerfile in your repository:

    FROM codeberg.org/readeck/readeck:latest
    

    # Environment configuration
    ENV READECK_SERVER_HOST=0.0.0.0
    ENV READECK_SERVER_PORT=8000
    ENV READECK_LOG_LEVEL=info
    

    # Expose the web interface
    EXPOSE 8000
    

    # Volume for data persistence
    VOLUME /readeck

    Push Your Repository to GitHub

    Commit and push your Dockerfile to your GitHub repository.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project named “readeck”.

    Create a New App

    Create a new app within your project and connect your GitHub repository.

    Configure HTTP Traffic

    In the deployment settings:

    • Select HTTP as the traffic type
    • Set the internal port to 8000

    Set Environment Variables

    Configure the following environment variables:

    VariableValue
    READECK_SERVER_HOST0.0.0.0
    READECK_SERVER_PORT8000
    READECK_LOG_LEVELinfo
    READECK_SECRET_KEYA secure random string

    Attach Persistent Volumes

    Add persistent storage:

    Mount PathRecommended SizePurpose
    /readeck10 GBDatabase, cached articles, and configuration

    Deploy Your Application

    Click Deploy to build and start your Readeck instance.

    Access Readeck

    Once deployment completes, access your Readeck instance at https://your-app-name.klutch.sh. Create your account on first visit.

Browser Extensions

Installing Extensions

Readeck provides browser extensions for quick saving:

  1. Access your Readeck settings
  2. Navigate to “Browser Extension”
  3. Install the extension for your browser
  4. Configure the extension with your Readeck URL

Saving Articles

With the extension installed:

  1. Navigate to an article you want to save
  2. Click the Readeck extension icon
  3. Optionally add labels
  4. Article is saved to your library

Organizing Content

Collections

Create collections to group related content:

  1. Navigate to Collections
  2. Create a new collection
  3. Add bookmarks to collections manually or via rules

Labels

Use labels for flexible categorization:

  1. Add labels when saving or editing
  2. Filter by labels in the main view
  3. Combine multiple labels for precise filtering

Additional Resources

Conclusion

Deploying Readeck on Klutch.sh provides a modern, self-hosted read-it-later solution with automatic builds, persistent storage, and secure HTTPS access. Save articles, organize your reading list, and enjoy distraction-free reading while keeping your data private.