Documentation — Rustume

Reference

Quickstart — Get Rustume running locally with make setup, make dev, or Docker in under five minutes.
Import Formats — Import resumes from JSON Resume, LinkedIn exports, and Reactive Resume via rustume parse.

Docker Deployment — Run Rustume from ghcr.io/lgtm-hq/rustume, build from source, verify signatures, and use Docker Compose.
Self-Hosting — Expose Rustume on the internet with a reverse proxy, TLS, and GET /health probes.
Rate Limits — Per-route request limits for Rustume Cloud and connected deployments, including defaults, configuration, and client behavior.
Environment Variables — Configuration reference for self-hosted server operation and connected Cloud mode with PostgreSQL and WorkOS.
Supply Chain Security — Verify Docker image signatures with cosign, inspect SLSA provenance and SBOM attestations.

Architecture Overview — Rust workspace crate map, dependency flow, and component responsibilities.
Cloud Stack — Hosted Rustume Cloud architecture for managed compute, PostgreSQL, identity, billing, object storage, and observability services.
Cloud Data Model — PostgreSQL responsibilities for WorkOS-linked accounts, synced resumes, history, publishing, and hosted billing records.

Monitoring — Server health, bearer-protected /metrics, and optional Sentry integration.
Backups — Recovery guidance for PostgreSQL-backed connected deployments and the operated Rustume Cloud service.
Terraform Infrastructure — Infrastructure-as-code responsibilities for the operated Rustume Cloud production stack.
Secrets Rotation — Rotate SESSION_SECRET, WorkOS keys, METRICS_TOKEN, and database credentials with minimal downtime.

Development Setup — Guide for setting up and running Rustume locally for development.
Linting & Formatting — Use lintro for linting and formatting checks.
Web App — SolidJS resume builder structure, stores, components, and WASM integration.