Configuration

# This value is optional and defaults to 'dboxed'. It is used as a prefix
# whenever dboxed needs to create resources in the outside world, e.g.
# instance names in AWS or Hetzner.
instanceName: dboxed
 
# This section is required and specifies the database connection. Currently,
# only postgres is supported.
db:
  url: postgresql://<user>:<password>@<host>:<port>/<database>
  # If set to true, dboxed will perform database migrations on start.
  # This will however only be done by the 'dboxed server run api' and
  # 'dboxed server run all' commands.
  migrate: true
 
# This section specifies how users can authenticate against the dboxed api
# and the frontend. Currently, only OIDC is supported, which means that an
# external OIDC compliant provider is required.
auth:
  oidc:
    issuerUrl: https://my.auth.provider
    clientId: my-client-id
 
    # These values define different claims to be extracted from the OIDC token.
    usernameClaim: email  # 'email' is the default if not specified
    emailClaim: email     # 'email' is the default if not specified
    fullNameClaim: name   # 'name' is the default if not specified
 
    adminUsers:
      # These entries specify which users should have admin rights. Use one of id or email.
      - id: 012345678asdcdef
        email: admin@example.com
 
# This section configures server related settings
server:
  # This is the address to listen on. Use 0.0.0.0:5000 to listen on all IPs.
  listenAddress: "127.0.0.1:5000"
  # This url is used when the publicly reachable URL of the API needs to be used, for
  # example when provisioning cloud servers which need to contact the API.
  baseUrl: "https://api.dboxed.example.com/"
 
# This section configures the default quotas per workspace.
defaultWorkspaceQuotas:
  # maxLogBytes specifies the maximum bytes allowed for all combined logs
  maxLogBytes: 100Mi