Files
klarbild-oss/.env.example
T
tillandClaude Opus 5 e2481139a1
CI / check (push) Has been cancelled
Klarbild 1.0.0 — first public release
A self-hosted print studio: images at exact physical sizes, sheet layout with
crop marks, tiling, 1:1 PDF. Everything else — image generation, delivery,
share links, mail, Telegram — is an optional module that is off by default.

This is the neutral public twin of a private tool. Compared to that original:

- optional modules behind KLARBILD_MODULES; the default install is print-only
- English interface with German as a full second language (1,038 strings);
  the English sentence is the translation key
- no built-in accounts — first boot creates one admin from ADMIN_USERNAME /
  ADMIN_PASSWORD, or generates a password and logs it once
- delivery and backup targets are generic SFTP/FTPS endpoints, off by default
- English routes, English identifiers, English comments throughout
- two compose files: print-only by default, everything in the full one
- AGPL-3.0, CI (build, tests, type check, secret scan), CONTRIBUTING, SECURITY

124 tests green, type check clean, verified end to end against a live instance.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nh4A79bbqT9dcd2inzYUdg
2026-09-15 14:52:41 +00:00

120 lines
7.4 KiB
Bash

# Klarbild — configuration
#
# Copy to .env and fill in. Never commit the real file.
# Everything below the first block is optional: Klarbild starts, and the print
# studio works, with nothing but DATABASE_URL, SESSION_SECRET and ENCRYPTION_KEY.
# ─────────────────────────────────────────────────────────────────────────────
# 1. The minimum — this is all a print-only instance needs
# ─────────────────────────────────────────────────────────────────────────────
DATABASE_URL=postgres://klarbild:CHANGEME@db:5432/klarbild
# Signs the session cookie. Any long random string.
# openssl rand -base64 48
SESSION_SECRET=
# Encrypts the credentials Klarbild stores in the database (SMTP password,
# delivery password, API keys). Exactly 32 bytes as 64 hex characters.
# openssl rand -hex 32
# Losing this means losing those stored credentials — they cannot be recovered,
# only re-entered.
ENCRYPTION_KEY=
# Where finished files live. `fs` writes to a volume and needs nothing else;
# `s3` talks to MinIO or any S3-compatible store (see section 7).
STORAGE_DRIVER=fs
STORAGE_DIR=/data
# Which modules are on. `print` is always on, with or without this line.
# print the print studio alone (default)
# print,ai,share add image generation and share links
# all everything
# See src/lib/modules.ts for the full list: print, ai, delivery, mirror,
# share, mail, telegram.
KLARBILD_MODULES=print
# Interface language: en (default) or de. Visitors can switch with ?lang=,
# which sets a cookie; this is only what they get before they choose.
KLARBILD_LOCALE=en
# Timezone for the timestamp in generated file names.
KLARBILD_TZ=Europe/Berlin
PORT=4321
# ─────────────────────────────────────────────────────────────────────────────
# 2. First start
# ─────────────────────────────────────────────────────────────────────────────
# The first boot creates exactly one administrator. Set these and it uses them;
# leave them empty and Klarbild generates a password and prints it once to the
# server log. There are no other built-in accounts.
ADMIN_USERNAME=admin
ADMIN_PASSWORD=
# ─────────────────────────────────────────────────────────────────────────────
# 3. Public address
# ─────────────────────────────────────────────────────────────────────────────
# Needed for share links and for the Telegram webhook. Behind a reverse proxy
# this is the address the browser sees, not the container port.
PUBLIC_BASE_URL=http://localhost:4321
# ─────────────────────────────────────────────────────────────────────────────
# 4. Module: ai — image generation
# ─────────────────────────────────────────────────────────────────────────────
# Klarbild calls image models through OpenRouter. This costs money per image.
# The key can also be entered in the admin area; the database value wins.
OPENROUTER_API_KEY=
# ─────────────────────────────────────────────────────────────────────────────
# 5. Module: mail
# ─────────────────────────────────────────────────────────────────────────────
# Klarbild sends through your own mailbox rather than a delivery service, so
# SPF and DKIM are already right and no third party reads along. These values
# apply until something is entered under Admin → Email, which then takes over.
SMTP_HOST=
SMTP_PORT=587
SMTP_SECURE=false
SMTP_USER=
SMTP_PASSWORD=
SMTP_FROM=
# ─────────────────────────────────────────────────────────────────────────────
# 6. Module: delivery — push finished files to a server you already have
# ─────────────────────────────────────────────────────────────────────────────
# The target itself (host, protocol, user, password) is configured in the admin
# area, because the password belongs in the encrypted settings row, not here.
# This is only the folder used when nothing more specific is set.
DELIVERY_DEFAULT_FOLDER=klarbild
# ─────────────────────────────────────────────────────────────────────────────
# 7. Module: telegram
# ─────────────────────────────────────────────────────────────────────────────
# A bot token from @BotFather. The webhook registers itself after deploy and
# needs PUBLIC_BASE_URL to be reachable from the internet.
TELEGRAM_BOT_TOKEN=
# ─────────────────────────────────────────────────────────────────────────────
# 8. S3 / MinIO — only when STORAGE_DRIVER=s3
# ─────────────────────────────────────────────────────────────────────────────
S3_ENDPOINT=http://minio:9000
S3_REGION=us-east-1
S3_BUCKET=klarbild
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_FORCE_PATH_STYLE=true
# ─────────────────────────────────────────────────────────────────────────────
# 9. Optional
# ─────────────────────────────────────────────────────────────────────────────
# A webhook that gets a POST when a job finishes — for n8n and the like.
N8N_WEBHOOK_URL=