Yopass Documentation
Yopass encrypts secrets in the browser using OpenPGP before anything leaves the user's machine. The server stores only ciphertext and never sees plaintext. Secrets self-destruct after retrieval or when their configured expiration passes.
Guides
Quick StartDocker Compose setup in five minutes. Redis or Memcached, your choice.TLS / HTTPSBuilt-in TLS or reverse proxy setup with Nginx, Caddy, and Traefik.File StorageDisk and S3/MinIO backends, upload size limits, lifecycle rules.Read-Only ModeSplit-instance deployment separating secret creation from retrieval.Theming & BrandingCustom logo, colors, and app name. License requiredOpenID ConnectOIDC setup, multi-instance session sharing, domain restrictions. License requiredAudit LoggingNDJSON compliance logging for SOC 2, ISO 27001, and GDPR. License requiredMetricsPrometheus scrape config, HTTP metrics, alerting rules, Grafana queries.Server OptionsComplete reference for all
yopass-server flags and environment variables.Redis SentinelHighly available Redis or Valkey with automatic failover.Secret RequestsAsk someone to send you a secret through an encrypted request link. License requiredRead ReceiptsSee whether and when a shared secret was opened. License requiredWebhooksPush secret lifecycle events to your own systems. License requiredCommand-Line InterfaceShare secrets and files from the terminal.APICreate and retrieve secrets over HTTP, with a worked example.Premium features
The following features require a valid --license-key. See pricing for details.
| Feature | Docs |
|---|---|
| OpenID Connect authentication | openid-connect |
| Custom theming & branding | theming |
| Audit logging | audit-logging |
| Secret requests | secret-requests |
| Read receipts | read-receipts |
| Webhooks | webhooks |
| Increased file size limit (>1 MB) | file-storage |
Resources
- GitHub Repository — source code, issues, releases
- Live Demo — try Yopass without installing anything
- Pricing — business license with premium features