tgstation-server/src/Tgstation.Server.Host/appsettings.yml

# Base tgstation-server configuration file
# You SHOULD NOT edit this file. Instead, make changes in its override file: appsettings.Production.yml
General:
# ConfigVersion: # Basic semver. Differs from TGS version to version. See changelog for current version
  MinimumPasswordLength: 15 # Minimum TGS user password length
  GitHubAccessToken: # GitHub personal access token with no scopes used to bypass rate-limits
  SetupWizardMode: AutoDetect # If the interactive TGS setup wizard should run
  ByondTopicTimeout: 5000 # Timeout for BYOND /world/Topic() calls in milliseconds
  RestartTimeoutMinutes: 1 # Timeout for server restarts after requested by SIGTERM or the HTTP API
  ApiPort: 5000 # Port the HTTP API is hosted on
  UseBasicWatchdog: false # The basic watchdog hard restarts DreamDaemon when /world/proc/TgsReboot() is called in the DMAPI if a new deployment is available
  UserLimit: 100 # Maximum number of allowed users
  UserGroupLimit: 25 # Maximum number of allowed groups
  InstanceLimit: 10 # Maximum number of allowed instances
  ValidInstancePaths: # An array of directories instances may be created in (either directly or as a subdirectory). null removes the restriction
  HostApiDocumentation: false # Make HTTP API documentation available at /api/doc/tgs_api.json
  SkipAddingByondFirewallException: false # Windows Only: Prevent running netsh.exe to add a firewall exception for installed engine binaries
  DeploymentDirectoryCopyTasksPerCore: 100 # Maximum number of concurrent file copy operations PER available CPU core
  OpenDreamGitUrl: https://github.com/OpenDreamProject/OpenDream # The repository to retrieve OpenDream from
  OpenDreamGitTagPrefix: v # The prefix to the OpenDream semver as tags appear in the git repository
  OpenDreamSuppressInstallOutput: false # Suppress the dotnet output of creating an OpenDream installation. Known to cause hangs in CI.
Session:
  HighPriorityLiveDreamDaemon: false # If DreamDaemon instances should run as higher priority processes
  LowPriorityDeploymentProcesses: true # If TGS Deployments should run as lower priority processes
  DelayCleaningFailedDeployments: false # If true, deployments that fail will not be immediately cleaned up. They will be cleaned up the next time the instance is onlined
FileLogging:
  Directory: # Directory in which log files are stored. Windows default: %PROGRAMDATA%/tgstation-server. Linux default: /var/log/tgstation-server
  Disable: true # Disable file logging entirely
  LogLevel: Debug # Level of file logging verbosity. Can be one of Trace, Debug, Information, Warning, Error, or Critical
  MicrosoftLogLevel: Warning # Level of file logging verbosity from Microsoft dependecies (i.e. webserver, database object relational mapper, etc...). Can be one of Trace, Debug, Information, Warning, Error, or Critical
Logging:
  Debug:
    LogLevel:
      Default: Debug # Level of debugger logging verbosity. Can be one of Trace, Debug, Information, Warning, Error, or Critical.
      Microsoft: Information # Level of file logging verbosity from Microsoft dependecies (i.e. webserver, database object relational mapper, etc...). Can be one of Trace, Debug, Information, Warning, Error, or Critical
  Console:
    LogLevel:
      Default: Trace # Level of stdout logging verbosity. Can be one of Trace, Debug, Information, Warning, Error, or Critical.
      Microsoft: Warning # Level of stdout verbosity from Microsoft dependecies (i.e. webserver, database object relational mapper, etc...). Can be one of Trace, Debug, Information, Warning, Error, or Critical
ControlPanel:
  Enable: false # If the web control panel is hosted alongside the server
  Channel: https://tgstation.github.io/tgstation-server-webpanel/api/${Major}.${Minor}.${Patch} # Channel for live web control panel updates. The tokens ${Major}, ${Minor}, and ${Patch} are substituted for the version of the HTTP API TGS was built with
  AllowAnyOrigin: false # Enable the `Access-Control-Allow-Origin: *` header for HTTP responses
  AllowedOrigins: [] # Explict list of origins for `Access-Control-Allow-Origin:` HTTP header. Ignored if AllowAnyOrigin is true
  PublicPath: # Used if TGS is not hosted at the website root. If TGS is hosted under `https://domain.com/tgs`, this should be `/tgs`
Updates:
  GitHubRepositoryId: 92952846 # GitHub repostiory ID where TGS updates can be found in releases
  GitTagPrefix: tgstation-server-v # Git tag prefix used for locating server update releases
  UpdatePackageAssetName: ServerUpdatePackage.zip # Name of the .zip file asset that contains the server update
Database:
  DatabaseType: SqlServer # The database type TGS connects to
  ServerVersion: # The version of the database being connected to, generally not required to be specified
  ConnectionString: Data Source=(local);Initial Catalog=TGS;Integrated Security=True;Encrypt=false # The connection string used to establish the database connection. Format varies for each DatabaseType
  DropDatabase: false # DANGEROUS! Causes TGS to recreate its database on startup. Must be unset manually
  ResetAdminPassword: false # DANGEROUS! Causes TGS to reset the `Admin` user password back to its default value on startup. Must be unset manually.
Security:
  TokenExpiryMinutes: 15 # Length of time in minutes a login session token is valid for
  TokenClockSkewMinutes: 1 # Clock skew allowance for validating loging tokens
  TokenSigningKeyByteAmount: 256 # Length of generated token signing key in bytes. Ignored if CustomTokenSigningKeyBase64 is set
  CustomTokenSigningKeyBase64: #
  OAuth:
#    Example:
#     RedirectUrl: # Return URL for OAuth handshake. For a server hosted at `https://domain.com/tgs`, this should be in the format `https://domain.com/tgs/app/`
#     ClientId: # OAuth client ID
#     ClientSecret: # OAuth client secret
#     ServerUrl: # Only used by Keycloak and InvisionCommunity. Server URL (Includes Keycloak realm)
#     UserInformationUrlOverride: # Not supported by GitHub. Overrides the URL TGS uses to retrieve a user's information
    GitHub: # https://github.com OAuth configuration
    Discord: # https://discord.com OAuth configuration
    TGForums: # https://tgstation13.org OAuth configuration
    Keycloak: # Keycloak OAuth configuration.
    InvisionCommunity: # Invision Community OAuth configuration.
Swarm: # Should be left empty if using swarm mode is not desired
# Identifier: # Required: The string identifier of the swarm node
# PrivateKey: # Required: The shared API key used for inter-server communication in the swarm. Must be the same secure string on all nodes
# Address: # Required: The internal address of the swarm node's API
# PublicAddress: # The public address of the swarm node
# ControllerAddress: # Required on non-controller nodes. The internal address of the swarm controller's API'. Should be left empty on the controller itself
# UpdateRequiredNodeCount: # The number of nodes expected to be in the swarm before initiating an update. This should count every server irrespective of whether or not they are the controller MINUS 1