Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A DynamoDB-compatible API adapter, ExtendDB speaks the DynamoDB wire protocol
- TLS with automatic self-signed certificate generation (replaceable with CA-signed certs)
- CSRF protection, security headers, session management
- JSON metrics endpoint with DynamoDB CloudWatch-style metric names and dimensions
- Daemon mode with syslog logging
- Daemon mode with syslog logging, plus `--foreground` for container and supervisor environments
- PostgreSQL storage — use standard backup, replication, and HA tools

## Quick Start
Expand Down Expand Up @@ -104,6 +104,16 @@ cert_path = "/etc/extenddb/tls/cert.pem"
key_path = "/etc/extenddb/tls/key.pem"
```

## Running in Containers

By default `extenddb serve` daemonizes itself, which doesn't play well with container runtimes and process supervisors that expect PID 1 to stay attached. Pass `--foreground` (alias `--no-daemon`) to keep the process in the foreground and stream logs to stderr instead of syslog:

```bash
extenddb serve --config extenddb.toml --foreground
```

Use this with Docker, Kubernetes, `systemd Type=simple`, runit, s6, or any other supervisor that captures stdout/stderr. `extenddb status` and `extenddb stop` continue to work as in daemon mode, since the PID file is still written.

## Monitoring

```bash
Expand All @@ -128,6 +138,7 @@ Web-based administration at `https://127.0.0.1:8000/console/`. Manage accounts,

```
extenddb serve --config extenddb.toml # Start server (daemon)
extenddb serve --config extenddb.toml --foreground # Start in foreground
extenddb init --catalog-db NAME # Initialize deployment
extenddb stop --config extenddb.toml # Graceful shutdown
extenddb status --config extenddb.toml # Check if running
Expand Down
Loading
Loading