marcandClaude Opus 5
92d525b3ab
The app is meant to run in daily private use now, so this pass was mostly
about the ways it could quietly lose data.
Reliability and security:
- the server no longer invents a JWT_SECRET or ENCRYPTION_KEY when one is
missing; it refuses to start. The old fallback silently made every stored
note unreadable after a restart.
- notes are encrypted with AES-256-GCM (v2:); existing CBC bodies still read.
- login is rate limited and compares against a dummy hash when the user does
not exist, so timing does not reveal who is registered.
- a server response issued before a local save is never adopted. This had
already eaten drawing strokes and note links; sync.hasPendingWrites() now
guards every path that takes a body from the server.
Editor and features:
- TipTap replaces the contenteditable editor: tables, task lists, and links
to other notes and notebooks, with a backlinks bar on the target.
- content format v2 ({v:2,doc}); v1 {html,tasks} bodies migrate on open.
- version history: the state before each write is snapshotted, coalesced
into 5-minute windows, 50 versions or 90 days per note.
- full-text search runs in the client, because the server cannot read
encrypted bodies and a server index would defeat the encryption.
- image attachments are stored by SHA-256 and deduplicated; the client
fetches them authenticated and caches the blob, so they work offline.
- drawings are vector strokes in a fixed 1200x1600 page space and now look
the same on every screen (0.0-0.2% deviation across four widths).
- login is by username; existing email accounts migrate automatically.
Operations:
- data lives on host bind mounts, not Docker volumes, so Proxmox Backup
covers it. Back up .env with it — without ENCRYPTION_KEY the dump is
unreadable.
Structure:
- NoteApp.jsx is gone. App.jsx now holds only where the user is; note data,
search, layout, history and drag each live behind a hook, and the four
panes are stateless.
- the whole data layer is TypeScript, with 81 unit tests concentrated on
the places that have actually broken.
- fixed along the way: the browser back button had a dead press, because
restoring a history entry pushed a duplicate one.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
54 lines
2.0 KiB
YAML
54 lines
2.0 KiB
YAML
version: "3.8"
|
|
|
|
# ─────────────────────────────────────────────
|
|
# InkNote — Deploy on Docker VM
|
|
# Pull images from Gitea container registry
|
|
#
|
|
# Usage:
|
|
# mkdir -p /srv/inknote/db /srv/inknote/uploads
|
|
# chown -R 1000:1000 /srv/inknote
|
|
# docker login gitea.honeyy.duckdns.org
|
|
# docker compose pull
|
|
# docker compose up -d
|
|
#
|
|
# Data lives under INKNOTE_DATA_DIR (default /srv/inknote) on the host.
|
|
# Back that path up together with the .env holding ENCRYPTION_KEY — the
|
|
# database is encrypted and is unreadable without that key.
|
|
# ─────────────────────────────────────────────
|
|
|
|
services:
|
|
inknote-server:
|
|
image: gitea.honeyy.duckdns.org/marc/inknote-server:latest # ← Change 'marc' to your Gitea username
|
|
container_name: inknote-server
|
|
restart: unless-stopped
|
|
environment:
|
|
- PORT=4000
|
|
- JWT_SECRET=${JWT_SECRET}
|
|
- ENCRYPTION_KEY=${ENCRYPTION_KEY}
|
|
- NODE_ENV=production
|
|
# Bind mounts, not named volumes: the data sits in a plain directory on the
|
|
# Docker host, so whatever backs up the host also backs up InkNote.
|
|
# Create it first: mkdir -p /srv/inknote/{db,uploads} && chown -R 1000:1000 /srv/inknote
|
|
user: "${INKNOTE_UID:-1000}:${INKNOTE_GID:-1000}"
|
|
volumes:
|
|
- ${INKNOTE_DATA_DIR:-/srv/inknote}/db:/app/data
|
|
- ${INKNOTE_DATA_DIR:-/srv/inknote}/uploads:/app/uploads
|
|
healthcheck:
|
|
test: ["CMD", "wget", "-qO-", "http://localhost:4000/api/health"]
|
|
interval: 30s
|
|
timeout: 5s
|
|
retries: 3
|
|
|
|
inknote-web:
|
|
image: gitea.honeyy.duckdns.org/marc/inknote-web:latest # ← Change 'marc' to your Gitea username
|
|
container_name: inknote-web
|
|
restart: unless-stopped
|
|
ports:
|
|
- "3000:80"
|
|
depends_on:
|
|
inknote-server:
|
|
condition: service_healthy
|
|
|
|
volumes:
|
|
inknote-data:
|
|
inknote-uploads: |