Deployment Examples¶
Ready-to-use configurations for various deployment scenarios.
Docker Compose¶
Docker Compose examples for different deployment scenarios:
| Example | Description | Use Case |
|---|---|---|
| minimal | Basic deployment with AWS S3 | Quick evaluation, simple setups |
| external-db | External PostgreSQL database | Production with managed database |
| s3-compatible | S3-compatible storage (MinIO, Wasabi, etc.) | Self-hosted or alternative storage |
| full | Full stack with SSO | Enterprise deployments |
See Docker Compose Examples for detailed configuration.
Helm Charts¶
Kubernetes deployment examples using Helm:
| Example | Description | Use Case |
|---|---|---|
| minimal.yaml | Basic deployment with bundled PostgreSQL | Development, evaluation |
| production.yaml | Production-ready with TLS and replicas | Production deployments |
| external-db.yaml | External PostgreSQL database | Managed database services |
| ha.yaml | High availability with multiple replicas | Large-scale deployments |
| ingress/external.yaml | External ingress controller | AWS ALB, Cloudflare, GCP CLB, etc. |
| sso.yaml | SSO with Google, GitHub, OIDC, SAML, LDAP | Enterprise authentication |
See Helm Examples for detailed configuration.
Single Sign-On (SSO)¶
SSO provider configurations:
| Example | Description |
|---|---|
| Google OAuth2 authentication | |
| GitHub | GitHub OAuth2 authentication |
| Keycloak | Keycloak OIDC authentication |
| LDAP | OpenLDAP / Active Directory authentication |
See SSO Examples for detailed configuration.
Ingress / Reverse Proxy¶
Reverse proxy configurations for exposing DocShare:
| Example | Description | TLS | Best For |
|---|---|---|---|
| Caddy | Automatic HTTPS with Let's Encrypt | Automatic | Production, ease of use |
| Nginx | Traditional reverse proxy | Self-signed (demo) | Custom configurations, familiarity |
| Traefik | Modern proxy with auto-discovery | Let's Encrypt (optional) | Microservices, dynamic config |
| Tailscale | Private access via tailnet | MagicDNS (built-in) | Internal tools, zero-trust access |
See Ingress Examples for detailed configuration.
Choosing a Deployment Method¶
| Need | Recommended |
|---|---|
| Quick evaluation | Docker Compose minimal |
| Production with TLS | Docker Compose + Caddy or Helm with cert-manager |
| Kubernetes | Helm chart |
| Private access only | Tailscale ingress |
| Enterprise SSO | Keycloak or LDAP configuration |
| High availability | Helm HA configuration or external database |