mirror of https://github.com/bretzel-app/crumbs.git synced 2026-10-12 20:06:57 +02:00

Files

T

Frederic CabassutandClaude Opus 4.6 1bacd69443 docs: update FEATURES.md, DEPLOYMENT.md, and CLAUDE.md

- FEATURES.md: add rich text editor section (Tiptap, formatting toolbar,
  raw markdown mode) and expand text formatting list
- DEPLOYMENT.md: fix docker-compose example to use image from ghcr.io
  instead of local build
- CLAUDE.md: add documentation maintenance instructions, update CI/CD
  section to reflect consolidated bump.yml workflow

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-07 07:50:10 +01:00

2.6 KiB

Raw Blame History

Deployment Guide

Docker (Recommended)

Quick Start

docker compose up -d

Open http://localhost:3000 and set your password.

Custom Configuration

# docker-compose.yml
services:
  crumbs:
    image: ghcr.io/bretzel-app/crumbs:latest
    ports:
      - "8080:3000"  # Change external port
    volumes:
      - /path/to/data:/data  # Custom data location
    environment:
      - ORIGIN=https://notes.example.com  # Your domain
    restart: unless-stopped

Reverse Proxy (nginx)

server {
    listen 443 ssl;
    server_name notes.example.com;

    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # WebSocket support (for future live sync)
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

Set ORIGIN=https://notes.example.com in your docker-compose.yml.

Backup

The SQLite database and attachments are stored in /data:

# Backup
docker compose exec crumbs tar czf - /data > crumbs-backup.tar.gz

# Or copy the volume directly
docker cp crumbs:/data ./backup

Update

docker compose pull
docker compose up -d

Manual Deployment (Node.js)

Prerequisites

Node.js 22+
pnpm

Steps

# Clone and install
git clone <repo-url> crumbs
cd crumbs
pnpm install

# Build
pnpm build

# Set environment
export DATABASE_URL=./data/crumbs.db
export ORIGIN=http://localhost:3000
export NODE_ENV=production

# Run
node build

Environment Variables

Variable	Default	Description
`DATABASE_URL`	`./data/crumbs.db`	SQLite database path
`DATA_DIR`	`./data`	Directory for attachments
`ORIGIN`	`http://localhost:3000`	Server origin (required for CSRF)
`PORT`	`3000`	HTTP port
`NODE_ENV`	`development`	Set to `production` for deployment

Health Check

The Docker image includes a health check that pings /login:

docker inspect --format='{{.State.Health.Status}}' crumbs

Security Notes

Always use HTTPS in production (via reverse proxy)
Set a strong password (min 8 characters recommended)
The ORIGIN variable must match your actual domain for CSRF protection
Sessions expire after 30 days
Passwords are hashed with Argon2

2.6 KiB Raw Blame History