Self-host Karakeep with Levelrail

A self-hosted bookmark, note, and read-it-later manager with full-text search and tagging.

  • Authorkarakeep-app
  • LicenceAGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host Karakeep

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • ghcr.io/karakeep-app/karakeep:0.33.2
    • getmeili/meilisearch:v1.15.0
  2. Create the app

    2 services start in a single Compose app, with 2 named volume mounts for your data, on port 3000.

  3. Fill in the secrets

    3 secrets are generated and stored encrypted, 4 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Karakeep requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 3000 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Karakeep. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Karakeep docs page.

Deploy Karakeep your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Karakeep from the CLI

levelrail-cli templates deploy karakeep --name my-karakeep

Deploy Karakeep with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/karakeep/deploy

Karakeep configuration

Karakeep services

ServiceImagePortsVolumes
karakeep ghcr.io/karakeep-app/karakeep:0.33.2 3000 karakeep_data -> /data
meilisearch getmeili/meilisearch:v1.15.0 none karakeep_meili_data -> /meili_data

Karakeep environment variables

VariableServiceValue
DATA_DIR karakeep Preset by the template
MEILI_ADDR karakeep Preset by the template
MEILI_MASTER_KEY karakeep Generated at deploy
NEXTAUTH_SECRET karakeep Generated at deploy
NEXTAUTH_URL karakeep Preset by the template
MEILI_MASTER_KEY meilisearch Generated at deploy
MEILI_NO_ANALYTICS meilisearch Preset by the template

Ports and volumes

Ports
3000
Volumes
2 named mounts: karakeep_data -> /data, karakeep_meili_data -> /meili_data

Karakeep FAQ

How much memory does Karakeep need?

The catalog lists about 512 MiB of memory for Karakeep across its 2 services.

Does Karakeep run on arm64?

For Karakeep, an arm64 image is published; amd64 is image published.

What licence is Karakeep under?

Karakeep is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does Karakeep need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does Karakeep use?

Karakeep listens on port 3000 inside the stack.

Where does Karakeep keep its data?

In named volumes: karakeep_data mounted at /data and karakeep_meili_data mounted at /meili_data.

Can I deploy Karakeep on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id karakeep for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image ghcr.io/karakeep-app/karakeep:0.33.2, getmeili/meilisearch:v1.15.0 is what you deploy there.

levelrail-cli templates deploy karakeep --name my-karakeep