☔🎀 Translation made with simplicity, yet robust. ~ Backend portion of Arisu, made in Go.

# If registrations should be enabled on the server. If not, you are
# required to create a user on the administration dashboard.
#
# Type: Boolean
# Default: true
# Variable: TSUBAKI_REGISTRATIONS
registrations: Boolean

# DSN URI to link up Sentry to Tsubaki. This will output GraphQL, request, and database
# errors towards Sentry.
#
# Type: String?
# Default: nil
# Variable: TSUBAKI_SENTRY_DSN
sentry_dsn: String?

# If Tsubaki should send telemetry events to Arisu, read up on what we do
# before enabling: https://docs.arisu.land/telemetry
#
# Type: Boolean
# Default: false
# Variable: TSUBAKI_ENABLE_TELEMETRY
telemetry: Boolean

# Returns the site-name to embed on the navbar of your Fubuki instance.
#
# Type: String?
# Default: Arisu
# Variable: TSUBAKI_SITE_NAME
site_name: String?

# Returns the site icon to use when displayed on the website.
#
# Type: String?
# Default: https://cdn.arisu.land/lotus.png
# Variable: TSUBAKI_SITE_ICON
site_icon: String?

# Returns a number on how many retries before panicking on an unavailable port
# to run Tsubaki on. To disable this, use `-1` as the value.
#
# Type: Int
# Default: 5
# Max: 15
# Min: -1
# Variable: TSUBAKI_PORT_RETRY
port_retry: Int

# Uses a host URI when launching the HTTP server. If you wish to keep Tsubaki
# running internally, you can use `127.0.0.1` instead of the default `0.0.0.0`.
#
# Type: String
# Default: "0.0.0.0"
# Variable: TSUBAKI_HOST or HOST
host: String

# Uses a different port other than 2809. If the port is taken, it will
# try to find an available one round-robin style and use that one that
# isn't taken. You can set how many tries using the `port_retry` config
# variable.
#
# Type: Int
# Default: 28093
# Range: 80-65535 on root; 1024-65535 on non-root
port: Int

# Returns the configuration for using the filesystem, S3,
# or Google Cloud Storage to backup your projects.
#
# Type: FilesystemConfig
# Default:
#   fs:
#     directory: <cwd>/.arisu
# Prefix: TSUBAKI_STORAGE
storage:
  # Configures using the filesystem to host your projects, once the data
  # is removed, Arisu will fix it but cannot restore your projects.
  # If you're using Docker or Kubernetes, it is best assured that you
  # must create a volume so Arisu can interact with it.
  #
  # Type: FileSystemStorageConfig
  # Aliases: `fs`
  # Variable: TSUBAKI_STORAGE_FS_*
  filesystem:
    # Returns the directory to store your projects in. Arisu will attempt
    # to create a `arisu.lock` file to show that the directory can be used.
    #
    # Type: String
    # Variable: TSUBAKI_STORAGE_FS_DIRECTORY
    # Default: <cwd>/.arisu
    directory: String

  # Configures using S3 to host your projects, once the bucket is gone,
  # Arisu will attempt to create the bucket but your data will be lost.
  #
  # Type: S3StorageConfig
  s3:
    # Returns the provider to use when authenticating to S3. Arisu supports
    # Amazon S3, Wasabi, or using Minio. By default, it will attempt to use
    # Amazon S3.
    #
    # Type: S3Provider?
    # Variable: TSUBAKI_STORAGE_S3_PROVIDER
    # Default: S3Provider.AMAZON
    provider: S3Provider

    # Returns the bucket to use when storing files. If this bucket
    # doesn't exist, Arisu will attempt to create the bucket.
    # By default, Arisu will use `arisu` as the default bucket name
    # if this is not set.
    #
    # Type: String
    # Variable: TSUBAKI_STORAGE_S3_BUCKET
    # Default: "arisu"
    bucket: String

    # Returns the access key for authenticating to S3. If this isn't provided,
    # it will attempt to look for your credentials stored in `~/.aws`. This is a
    # recommended variable to set if using the S3 provider.
    #
    # Type: String
    # Variable: TSUBAKI_STORAGE_S3_ACCESS_KEY
    # Default: "access_key" key in ~/.aws/tsubaki_config
    access_key: String

    # Returns the secret key for authenticating to S3. If this isn't provided,
    # it will attempt to look for your credentials stored in `~/.aws`. This is a
    # recommended variable to set if using the S3 provider.
    #
    # Type: String
    # Variable: TSUBAKI_STORAGE_S3_SECRET_KEY
    # Default: "access_key" key in ~/.aws/tsubaki_config
    secret_key: String

    # Returns the region to host your bucket, this is dependant on if you
    # created the bucket without running Tsubaki. This is required to set to
    # so no errors will occur while authenticating to S3.
    #
    # Type: String
    # Variable: TSUBAKI_STORAGE_S3_REGION
    # Default: "us-east1"
    region: String

# Configuration to setup a Kafka producer to use for messaging queues.
# This is required if you're running the GitHub bot.
#
# Type: KafkaConfig
# Default: nil
# Prefix: TSUBAKI_KAFKA
kafka:
  # If the producer should auto create the topic for you.
  #
  # Type: Boolean
  # Variable: TSUBAKI_KAFKA_AUTO_CREATE_TOPICS
  # Default: true
  auto_create_topics: Boolean

  # A list of brokers to connect to. This returns a List of `host:port` strings. If you're
  # using an environment variable to set this, split it with `,` so it can be registered properly!
  #
  # Type: List<String>
  # Variable: TSUBAKI_KAFKA_BROKERS
  # Default: localhost:9092
  brokers: List<String>

  # Returns the topic to send messages towards the GitHub bot to Tsubaki.
  # Warning: This must be the same as the one you set on the GitHub bot configuration
  # or it will not receive messages.
  #
  # Type: String
  # Variable: TSUBAKI_KAFKA_TOPIC
  # Default: `arisu:tsubaki`
  topic: String

# Returns the configuration for using Redis to cache user sessions.
# Sentinel and Standalone are supported.
#
# Type: RedisConfig
# Default:
#   redis:
#     host: localhost
#     port: 6379
# Prefix: TSUBAKI_REDIS
redis:
  # Sets a list of sentinel servers to use when using Redis Sentinel
  # instead of Redis Standalone. The `master` key is required if this
  # is defined. This returns a List of `host:port` strings. If you're
  # using an environment variable to set this, split it with `,` so it can be registered properly!
  #
  # Type: List<String>?
  # Variable: TSUBAKI_REDIS_SENTINEL_SERVERS
  # Default: nil
  sentinels: List<String>?

  # If `requirepass` is set on your Redis server, this property will authenticate
  # Tsubaki once the connection is being dealt with.
  #
  # Type: String?
  # Variable: TSUBAKI_REDIS_PASSWORD
  # Default: nil
  password: String?

  # Returns the master name for connecting to any redis sentinel servers.
  #
  # Type: String?
  # Variable: TSUBAKI_REDIS_SENTINEL_MASTER
  # Default: nil
  master: String?

  # Returns the database index to use so you don't clutter your server
  # with Tsubaki-set configs.
  #
  # Type: Int
  # Variable: TSUBAKI_REDIS_DATABASE_INDEX
  # Default: 5
  index: Int

  # Returns the host for connecting to Redis.
  #
  # Type: String
  # Default: "localhost"
  # Variable: TSUBAKI_REDIS_HOST
  host: String

  # Returns the port to use when connecting to Redis.
  #
  # Type: Int
  # Default: 6379
  # Range: 80-65535 on root; 1024-65535 on non-root
  # Variable: TSUBAKI_REDIS_PORT
  port: Int