Skip to main content

Running with Docker

Synentra publishes pre-built images to the GitHub Container Registry (GHCR). The latest tag is a multi-arch manifest and works on all supported platforms automatically:

Image TagPlatformsNotes
ghcr.io/synentra/synentra:latestlinux/amd64, linux/arm64Recommended — Docker selects the correct variant automatically
ghcr.io/synentra/synentra:1.1.0-linux-amd64linux/amd64Platform-specific pin
ghcr.io/synentra/synentra:1.1.0-linux-arm64linux/arm64Platform-specific pin

All images:

  • Expose port 7080 (HTTP) by default
  • Set DOTNET_RUNNING_IN_CONTAINER=true

Pulling the Image​

For most cases, pull the multi-arch latest tag. Docker will automatically select the correct variant for your host:

docker pull ghcr.io/synentra/synentra:latest

To pin to a specific platform:

docker pull ghcr.io/synentra/synentra:1.1.0-linux-amd64

Running the Container​

Minimal (in-memory cache, SQLite)​

Start a basic instance with persistent storage and mounted policies:

docker run -d \
--name synentra \
-p 7080:7080 \
-e System__Storage__Database__Providers__Sqlite__ConnectionString="Data Source=/data/synentra.db" \
-e Policy__Providers__Internal__Directory="/policies" \
-v $(pwd)/data:/data \
-v $(pwd)/policies:/policies \
ghcr.io/synentra/synentra:latest

Verifying the Deployment​

  1. Check the container status:

    docker ps

    Expected output includes a container named synentra with a Up status.

  2. Test the gateway health endpoint:

    curl http://localhost:7080/health

    Expected response:

    {
    "status": "Healthy",
    "healthCheckDuration": "00:00:00.0123456"
    }

Environment Variables Reference​

ASP.NET Core reads configuration from environment variables using double-underscore __ as a section separator.

For example, System__Server__Http__Port=7080 maps to:

{
"System": {
"Server": {
"Http": {
"Port": 7080
}
}
}
}

All appsettings.json keys can be overridden via environment variables:

Environment VariableExample ValueDescription
System__Server__Http__Port7080HTTP listener port
System__Server__Https__EnabledtrueEnable HTTPS
System__Server__Https__Port7443HTTPS listener port
System__Storage__Database__DefaultProviderSqliteDatabase provider
System__Storage__Database__Providers__Sqlite__ConnectionStringData Source=/data/synentra.dbSQLite path
System__Storage__Database__Providers__Postgres__ConnectionStringHost=db;Database=synentra;...PostgreSQL connection
System__Storage__Cache__DefaultProviderMemory or RedisCache provider
System__Storage__Cache__Providers__Redis__ConnectionStringredis:6379Redis address
System__RateLimit__DefaultRequestsPerMinute60Per-agent rate limit
System__CircuitBreaker__FailureThreshold5Failures before circuit opens

See the Configuration Reference reference for all available settings.


Volume Mounts​

For production deployments, mount persistent volumes for the following container paths:

Container Path (Linux)Container Path (Windows)Purpose
/dataC:\dataSQLite database file
/policiesC:\policiesJSON policy files
/app/logsC:\app\logsSerilog file sink output
/certsC:\certsTLS certificate (if HTTPS enabled)

Docker Compose​

For deployments requiring additional services such as Redis (distributed cache), Seq (structured logging), or OPA (external policy engine), use the following Docker Compose setup:

docker-compose.yml
services:

synentra:
image: ghcr.io/synentra/synentra:latest
ports:
- "7080:7080"
environment:
System__Storage__Database__DefaultProvider: Sqlite
System__Storage__Database__Providers__Sqlite__ConnectionString: "Data Source=/data/synentra.db"
System__Storage__Cache__DefaultProvider: Redis
System__Storage__Cache__Providers__Redis__ConnectionString: "redis:6379"
System__RateLimit__DefaultRequestsPerMinute: "60"
System__CircuitBreaker__FailureThreshold: "5"
Security__AgentAuth__Provider: SelfSigned
Policy__Enabled: "true"
Policy__DefaultProvider: Internal
Policy__Providers__Internal__Directory: /policies
HumanInTheLoop__Enabled: "true"
HumanInTheLoop__Threshold: "0.8"
HumanInTheLoop__TimeoutSeconds: "3600"
Observability__Logging__DefaultLogLevel: Information
Observability__Logging__Seq__Enabled: "true"
Observability__Logging__Seq__ServerUrl: http://seq:5341
volumes:
- synentra-data:/data
- ./policies:/policies:ro
- synentra-logs:/app/logs
depends_on:
- redis
restart: unless-stopped
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:7080/health"]
interval: 30s
timeout: 5s
retries: 3
start_period: 10s

redis:
image: redis:7-alpine
ports:
- "6379:6379"
restart: unless-stopped

seq:
image: datalust/seq:latest
ports:
- "5341:5341"
- "8080:80"
environment:
ACCEPT_EULA: "Y"
volumes:
- seq-data:/data
restart: unless-stopped

volumes:
synentra-data:
synentra-logs:
seq-data:

Start the entire stack:

docker compose up -d

HTTPS in Docker​

Mount your certificate and set the relevant environment variables to enable HTTPS:

docker run -d \
--name synentra \
-p 7080:7080 \
-p 7443:7443 \
-e System__Server__Https__Enabled=true \
-e System__Server__Https__Port=7443 \
-e System__Server__Https__Certificate__Path=/certs/synentra.pfx \
-e System__Server__Https__Certificate__Password=your-cert-password \
-v $(pwd)/certs:/certs:ro \
ghcr.io/synentra/synentra:latest

User Security​

ImageRuns as
ghcr.io/synentra/synentra:latest (linux)root (see warning below)
Linux containers and root

The Linux image currently runs as root. For production deployments it is recommended to run the container with a non-root user by adding --user to your docker run command or setting user: in your Compose service.


Health Check​

Synentra exposes a /health endpoint. Use it for Docker health checks, Kubernetes readiness/liveness probes, and orchestration monitoring:

curl http://localhost:7080/health

Example response:

{
"status": "Healthy",
"healthCheckDuration": "00:00:00.0023456"
}

Was this helpful?