Skip to content

Environment Variables

Core Variables

VariableDefaultDescription
NEXUSDB_PORT4200Server port
NEXUSDB_HOST0.0.0.0Bind address
NEXUSDB_DATA_DIR./dataData storage path
NEXUSDB_LOG_LEVELinfoLog verbosity: debug, info, warn, error
NEXUSDB_ENVdevelopmentEnvironment: development, staging, production

Security

VariableDefaultDescription
NEXUSDB_SECRETJWT signing secret (required in production)
NEXUSDB_API_KEY_SALTSalt for API key hashing
NEXUSDB_CORS_ORIGINS*Comma-separated allowed origins
NEXUSDB_RATE_LIMIT1000Requests per minute per IP
NEXUSDB_TLS_CERTPath to TLS certificate
NEXUSDB_TLS_KEYPath to TLS private key

Storage Engine

VariableDefaultDescription
NEXUSDB_ENGINErocksdbStorage engine: rocksdb, sqlite, memory
NEXUSDB_MEMORY_LIMIT1024Max memory in MB
NEXUSDB_WAL_ENABLEDtrueWrite-ahead log
NEXUSDB_COMPRESSIONlz4Compression: none, lz4, zstd, snappy

Example .env File

# .env
NEXUSDB_PORT=4200
NEXUSDB_ENV=production
NEXUSDB_SECRET=your-secret-key-min-32-chars-here
NEXUSDB_DATA_DIR=/var/lib/nexusdb/data
NEXUSDB_LOG_LEVEL=warn
NEXUSDB_CORS_ORIGINS=https://app.example.com,https://admin.example.com
NEXUSDB_RATE_LIMIT=500
NEXUSDB_ENGINE=rocksdb
NEXUSDB_MEMORY_LIMIT=4096
NEXUSDB_COMPRESSION=zstd

Docker Compose

services:
  nexusdb:
    image: nexusdb/server:3.2
    ports:
      - "4200:4200"
    environment:
      NEXUSDB_ENV: production
      NEXUSDB_SECRET: ${NEXUSDB_SECRET}
      NEXUSDB_DATA_DIR: /data
      NEXUSDB_MEMORY_LIMIT: 4096
    volumes:
      - nexusdb-data:/data

volumes:
  nexusdb-data: