Setting Up Karakeep with Docker Compose¶

Introduction to Karakeep¶

Karakeep is a self-hosted bookmarking and note-saving application designed to help you manage and organise content effortlessly. It integrates MeiliSearch for full-text search and a headless Chrome browser for link previews and screenshots. This guide walks you through deploying Karakeep using Docker Compose.

Prerequisites¶

• Docker and Docker Compose installed on your system.
• Basic understanding of Docker Compose files.
• A .env file with the required environment variables.

Docker Compose Configuration for Karakeep¶

Docker Compose File (docker-compose.yml)¶

services:
  web:
    image: ghcr.io/karakeep-app/karakeep:${KARAKEEP_VERSION:-release}
    restart: unless-stopped
    volumes:
      - data:/data
    ports:
      - 3000:3000
    env_file:
      - .env
    environment:
      MEILI_ADDR: http://meilisearch:7700
      BROWSER_WEB_URL: http://chrome:9222
      # OPENAI_API_KEY: ...
      DATA_DIR: /data

  chrome:
    image: gcr.io/zenika-hub/alpine-chrome:123
    restart: unless-stopped
    command:
      - --no-sandbox
      - --disable-gpu
      - --disable-dev-shm-usage
      - --remote-debugging-address=0.0.0.0
      - --remote-debugging-port=9222
      - --hide-scrollbars

  meilisearch:
    image: getmeili/meilisearch:v1.15.0
    restart: unless-stopped
    env_file:
      - .env
    environment:
      MEILI_NO_ANALYTICS: "true"
    volumes:
      - meilisearch:/meili_data

volumes:
  meilisearch:
  data:

Environment Variables (.env)¶

KARAKEEP_VERSION=release
NEXTAUTH_SECRET=YourRandomSecureKey
MEILI_MASTER_KEY=YourMeiliMasterKey
NEXTAUTH_URL=http://yourdomain.com:3000

• Replace YourRandomSecureKey with a securely generated secret (e.g., using openssl rand -base64 36).
• Replace YourMeiliMasterKey with a securely generated key for MeiliSearch.
• Update NEXTAUTH_URL with your domain or IP address and port.

Key Components of the Configuration¶

Service: web (Karakeep)¶

• Image: ghcr.io/karakeep-app/karakeep:${KARAKEEP_VERSION:-release}
• Ports: Maps 3000:3000 for accessing Karakeep's web interface.
• Environment Variables:
• MEILI_ADDR: URL of the MeiliSearch service.
• BROWSER_WEB_URL: URL of the Alpine Chrome browser debugging service.
• DATA_DIR: Directory for storing Karakeep's data.

Service: chrome (Alpine Chrome)¶

• Image: gcr.io/zenika-hub/alpine-chrome:123
• Command: Configures Chrome for headless operation with remote debugging enabled.

Service: meilisearch¶

• Image: getmeili/meilisearch:v1.15.0
• Environment Variables:
• MEILI_NO_ANALYTICS: Disables analytics for privacy.

Volumes¶

• meilisearch: Stores MeiliSearch index data persistently.
• data: Stores Karakeep's application data persistently.

Preparing for Deployment¶

1. Prepare the .env File: Fill out the .env file with secure keys and URLs as described above.
2. Review Configuration: Ensure the docker-compose.yml and .env files are correctly set up for your environment.

Deploying Karakeep¶

1. Save the configuration in a docker-compose.yml file and create the .env file in the same directory.
2. Run the following command to start Karakeep and its dependencies:

   docker compose up -d
   

3. Access Karakeep at http://yourdomain.com:3000 (replace with your actual domain or IP and port).

Post-Deployment Tips¶

• Reverse Proxy: For improved security and accessibility, consider using a reverse proxy (e.g., Nginx Proxy Manager or Traefik) to serve Karakeep over HTTPS.
• OpenAI API Key: If you plan to use AI-powered tagging, set the OPENAI_API_KEY in the .env file.
• Secure Your Setup: Use strong, randomly generated secrets for all environment variables.

Troubleshooting¶

• Service Not Starting: Check for missing or incorrect values in the .env file.
• Connection Issues: Verify that MEILI_ADDR and BROWSER_WEB_URL are correctly configured and that those services are running.

Updating Karakeep¶

docker compose pull
docker compose up -d

If there is an issue with this guide or you wish to suggest changes, please raise an issue on GitHub.