Portainer Templates logo

Portainer Templates

Karakeep Karakeep

Stack

Productivity Pm

Karakeep (formerly Hoarder) - a self-hosted "bookmark everything" app: save links, notes, and images, and it automatically crawls and archives the page (so your links never rot), takes a screenshot, full-text indexes everything, and can

Configuration

Type
Compose
Platform
linux
Env vars
MEILI_MASTER_KEY=''NEXTAUTH_SECRET=''NEXTAUTH_URL=http://localhost:5000OLLAMA_BASE_URL=''OPENAI_API_KEY=''
Source
Repo

Template by deployable-sh·Source

Report issue

Services

karakeep

Configuration

Image
ghcr.io/karakeep-app/karakeep:0.32.0
Ports
5000:5000
Volumes
/data : data
Env vars
PORT=5000DATA_DIR=/dataNEXTAUTH_SECRET=${NEXTAUTH_SECRET}NEXTAUTH_URL=${NEXTAUTH_URL:-http://localhost:5000}MEILI_ADDR=http://meilisearch:7700MEILI_MASTER_KEY=${MEILI_MASTER_KEY}BROWSER_WEB_URL=http://chrome:9222OPENAI_API_KEY=${OPENAI_API_KEY:-}OLLAMA_BASE_URL=${OLLAMA_BASE_URL:-}
Restart
unless-stopped

Image details

User: karakeep-app

meilisearch

Configuration

Image
getmeili/meilisearch:v1.41.0
Volumes
/meili_data : meili
Env vars
MEILI_NO_ANALYTICS=trueMEILI_MASTER_KEY=${MEILI_MASTER_KEY}
Restart
unless-stopped

Image details

Pulls: 55.0M
User: getmeili
Created: Nov 22, 2019
Updated: 4 hours ago
Status: active

chrome

Configuration

Restart
unless-stopped
Build
./chrome

Standalone Install

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

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 Karakeep, fill in any config options, and hit Deploy

Template Import URL

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

The compose file this template deploys, straight from its repo:

name: karakeep

services:
  karakeep:
    image: ghcr.io/karakeep-app/karakeep:0.32.0
    restart: unless-stopped
    environment:
      PORT: "5000"
      DATA_DIR: /data
      NEXTAUTH_SECRET: ${NEXTAUTH_SECRET}
      NEXTAUTH_URL: ${NEXTAUTH_URL:-http://localhost:5000}
      MEILI_ADDR: http://meilisearch:7700
      MEILI_MASTER_KEY: ${MEILI_MASTER_KEY}
      BROWSER_WEB_URL: http://chrome:9222
      OPENAI_API_KEY: ${OPENAI_API_KEY:-}
      OLLAMA_BASE_URL: ${OLLAMA_BASE_URL:-}
    ports:
      - "5000:5000"
    depends_on:
      - meilisearch
      - chrome
    volumes:
      - data:/data

  meilisearch:
    image: getmeili/meilisearch:v1.41.0
    restart: unless-stopped
    environment:
      MEILI_NO_ANALYTICS: "true"
      MEILI_MASTER_KEY: ${MEILI_MASTER_KEY}
    volumes:
      - meili:/meili_data

  chrome:
    build: ./chrome
    restart: unless-stopped

volumes:
  data:
  meili:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f karakeep/compose.yaml up -d

More install options in our documentation.

Serve Karakeep 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 karakeep.example.com to http://karakeep:5000

Add this to your Caddyfile

karakeep.example.com {
	reverse_proxy http://karakeep:5000
}

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 <container>
  • 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:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 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:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, karakeep can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/karakeep-app/karakeep:0.32.0

  • "manifest unknown" means the tag no longer exists.
  • "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 <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

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

A Compose stack

Karakeep is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • karakeep runs ghcr.io/karakeep-app/karakeep:0.32.0, starts after meilisearch, chrome
  • meilisearch runs getmeili/meilisearch:v1.41.0
  • chrome

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000

Volumes

A volume is where Karakeep 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:

  • /data kept in the data volume Docker manages
  • /meili_data kept in the meili volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Karakeep takes 10 of them, all with defaults you can leave alone or tweak:

  • PORT, defaults to 5000
  • DATA_DIR, defaults to /data
  • NEXTAUTH_SECRET, pulled from your own environment
  • NEXTAUTH_URL, defaults to http://localhost:5000
  • MEILI_ADDR, defaults to http://meilisearch:7700
  • MEILI_MASTER_KEY, pulled from your own environment
  • BROWSER_WEB_URL, defaults to http://chrome:9222
  • OPENAI_API_KEY, pulled from your own environment
  • OLLAMA_BASE_URL, pulled from your own environment
  • MEILI_NO_ANALYTICS, defaults to true

Restart policy

The restart policy here is unless-stopped, so Docker restarts Karakeep 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

Portainer puts these services on one shared private network, so they can find each other by name (like karakeep) while only the ports above are open to you.

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 Karakeep up. Add the template list to Portainer once, then deploying Karakeep is a click rather than a wall of config.