No description
Find a file
2026-02-06 17:35:26 +00:00
.github ci: update to latest github checkout action 2026-02-06 17:35:26 +00:00
migrations fix(db): add AUTOINCREMENT to prevent SQLite ROWID reuse 2026-02-06 10:09:13 +00:00
scripts feat(brews): add quick notes 2026-02-05 20:42:03 +00:00
src feat(ui): add theme-aware SVG favicon that follows light/dark mode 2026-02-06 16:44:00 +00:00
static feat(ui): add theme-aware SVG favicon that follows light/dark mode 2026-02-06 16:44:00 +00:00
templates fix(ui): follow OS dark/light mode changes after manual toggle 2026-02-06 16:49:16 +00:00
tests refactor(tests): add CLI test macros and deduplicate helpers 2026-02-06 14:27:43 +00:00
.gitignore chore: add *.env to gitignore 2026-02-06 16:50:26 +00:00
build.rs feat(ui): enhance desktop tables and mobile card views 2026-02-06 15:40:40 +00:00
Cargo.lock chore: run cargo update 2026-02-06 17:34:57 +00:00
Cargo.toml chore: set the version to 1.0.0 2026-02-06 17:12:07 +00:00
CLAUDE.md docs: document test macros and generic helpers in CLAUDE.md 2026-02-06 14:27:51 +00:00
flake.lock chore: update flake.lock file 2026-02-06 17:27:49 +00:00
flake.nix fix: ensure openssl linking works in clean build environments 2026-02-06 17:34:50 +00:00
fly.toml feat: add fly.toml for production deployment 2026-02-06 17:14:56 +00:00
LICENSE docs: add LICENSE 2026-02-03 20:53:45 +00:00
README.md feat(nix): add Docker container build to flake 2026-02-06 16:47:05 +00:00

B{rew}log

B{rew}log is a self-hosted coffee logging platform for tracking roasters, roasts, brews, cafes and brewing gear. It ships as a single Rust binary that serves a web UI, a REST API, and a CLI client.

  • Web UI with reactive updates via Datastar and Tailwind CSS v4
  • REST API for programmatic access (reads are public, writes require auth)
  • CLI client for terminal-based workflows
  • AI extraction — scan a coffee bag label or type a description to auto-fill forms (via OpenRouter)
  • Nearby cafe search powered by Foursquare Places
  • SQLite database
  • Passkey authentication — no passwords, WebAuthn only

Quick Start

Install

cargo install --git https://github.com/jnsgruk/brewlog.git

Configure

Create a .env file (or export the variables). Four values are required:

BREWLOG_RP_ID="localhost"
BREWLOG_RP_ORIGIN="http://localhost:3000"
BREWLOG_OPENROUTER_API_KEY="sk-or-..."
BREWLOG_FOURSQUARE_API_KEY="fsq3..."

Run

brewlog serve

On first start with an empty database the server prints a one-time registration URL:

No users found. Register the first user at:
  http://localhost:3000/register/abc123...
This link expires in 1 hour.

Open that URL, choose a display name, and register a passkey. This creates your account and signs you in.

CLI Authentication

To use the CLI or API for write operations, create a token via browser handoff:

brewlog token create --name "my-cli-token"
# Browser opens → authenticate with your passkey → token printed once

export BREWLOG_URL="http://localhost:3000"
export BREWLOG_TOKEN="<token from above>"

# Now you can create data from the CLI
brewlog roaster add --name "Radical Roasters" --country "United Kingdom"

Run brewlog --help for the full command reference.

Configuration

All settings are read from environment variables or CLI flags. A .env file in the working directory is loaded automatically via dotenvy.

Server (brewlog serve)

Variable Purpose Default
BREWLOG_RP_ID WebAuthn Relying Party ID (your domain) required
BREWLOG_RP_ORIGIN WebAuthn Relying Party origin (full URL) required
BREWLOG_DATABASE_URL Database connection string sqlite://brewlog.db
BREWLOG_BIND_ADDRESS Server bind address 127.0.0.1:3000
BREWLOG_SECURE_COOKIES Enable the Secure cookie flag (set true for HTTPS) false
RUST_LOG Log level filter info
RUST_LOG_FORMAT Set to json for structured log output

CLI Client

Variable Purpose Default
BREWLOG_URL Server URL http://localhost:3000
BREWLOG_TOKEN API bearer token for write operations

Integrations

Variable Purpose Default
BREWLOG_OPENROUTER_API_KEY OpenRouter API key for AI extraction required
BREWLOG_OPENROUTER_MODEL LLM model for AI extraction openrouter/free
BREWLOG_FOURSQUARE_API_KEY Foursquare Places API key for nearby cafe search required

Database

SQLite is used for storage. Migrations run automatically on server startup.

Running with Docker

The Nix flake includes a Docker image built with dockerTools:

nix build .#brewlog-container
docker load < result

Create a docker.env file:

BREWLOG_ADMIN_USERNAME=admin
BREWLOG_ADMIN_PASSWORD=password
BREWLOG_OPENROUTER_API_KEY=sk-or-...
BREWLOG_OPENROUTER_MODEL=google/gemini-3-flash-preview
BREWLOG_FOURSQUARE_API_KEY=fsq3...
BREWLOG_RP_ID=localhost
BREWLOG_BIND_ADDRESS=0.0.0.0:3000
BREWLOG_RP_ORIGIN=http://localhost:4000
mkdir data
docker run --rm -p 4000:3000 --env-file docker.env -v $PWD/data:/data brewlog:0.1.0

The database is stored at /data/brewlog.db inside the container — mount a host directory to /data to persist it.

Contributing

cargo build                           # Build
cargo clippy --allow-dirty --fix      # Lint
cargo fmt                             # Format
cargo test                            # Test

See CLAUDE.md for architecture, code patterns, and development conventions.

License

Apache License 2.0