Skip to content

🐳 Deployment & Operations Overview ​

ShellGuard is designed for absolute self-hosting sovereignty. It compiles into a single, unified Docker container (node:20-alpine) that serves both the compiled React client UI and the Express 5 backend API. There are zero mandatory external dependencies, no third-party cloud brokers, and no external database daemons required.


🏗️ Deployment Guides ​


⚙️ Environment Configuration Matrix ​

All production settings are configured via standard environment variables:

VariableDefaultRequiredDescription
PORT6464 (Docker) / 6565 (Dev)NoTCP listening port for the Express application.
DATA_DIR/app/dataYesPath to persistent storage containing db.sqlite, audit.sqlite, and backups.
DB_ENCRYPTION_KEY(Empty)Yes256-bit Base64 key for Layer 2 metadata encryption & SQLCipher whole-DB encryption. Generate via openssl rand -base64 32.
ADMIN_TOKEN(Empty)YesAuthentication token for the SuperLobster control plane at /superlobster.
TLS_ENABLEDfalseNoWhen true, automatically generates a persistent 10-year self-signed EC P-256 certificate for LAN HTTPS.
TLS_CERT_PATH(Generated)NoOptional path to custom TLS certificate PEM file.
TLS_KEY_PATH(Generated)NoOptional path to custom TLS private key PEM file.
PUID1000NoLinux user ID for container file ownership (99 on Unraid).
PGID1000NoLinux group ID for container file ownership (100 on Unraid).
TRUST_PROXYfalseNoSet to true when running behind Nginx, Caddy, Cloudflare, or Traefik.
CORS_ORIGIN(Empty)NoOptional allowed CORS origins for external API clients.
TOKEN_TTL_DEFAULT24hNoDefault expiration lifetime for user session tokens (1h, 24h, 7d).
NODE_ENVproductionNoNode runtime environment (production or development).

🩺 Health Check Endpoint ​

ShellGuard exposes an unauthenticated health check endpoint at GET /api/health:

bash
curl -k https://localhost:6565/api/health

Response Payload: ​

json
{
  "success": true,
  "service": "ShellGuard API",
  "version": "0.0.3.0",
  "mode": "sqlite",
  "uptime": 3612.45,
  "counts": {
    "vaultPearls": 42,
    "secureNotes": 12,
    "sshKeys": 5,
    "attachments": 8,
    "agentKeys": 3
  }
}

Container orchestrators (Docker, Kubernetes, Nomad) use this endpoint to monitor container health and automatically restart degraded instances.

Sovereign Zero-Knowledge Secrets Vault. Released under AGPL-3.0. • Privacy Policy