# Primary Magnetar configuration.
# The location of the config to load may be overriden with MAG_CONFIG_PATH.

# Please note options in this file take priority over environment variables.

# Container quick start:
# Technically it's not necessary to edit this file at all.
# Set the following variables:
#   - MAG_C_HOST (host)
#   - MAG_C_DATABASE_URL (Postgres database connection URL)


# --------------------------------[ LOGGING ]----------------------------------

# Logging can be configured using the RUST_LOG environment variable.
# See https://docs.rs/env_logger/0.10.0/env_logger/#enabling-logging
# Default: "info"

# -------------------------------[ NETWORKING ]--------------------------------

# Magnetar does not contain a TLS ingress, please use a reverse proxy like:
#   - Nginx (https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)
#   - Caddy (https://caddyserver.com/docs/quick-starts/reverse-proxy)
#   - Traefik

# [REQUIRED]
# The hostname the instance will run on.
# Environment variable: MAG_C_HOST
# networking.host = "example.com"

# [Optional]
# The port of the instance.
# Default: 4939
# Environment variable: MAG_C_PORT
# networking.port = 4939

# [Optional]
# The protocol to use for the instance.
# Possible values: "http", "https"
# Default: "https"
# Environment variable: MAG_C_PROTOCOL
# networking.protocol = "https"

# [Optional]
# The IP address the application will bind to.
# Default: "::"
# Environment variable: MAG_C_BIND_ADDR
# networking.bind_addr = "::"

# [Optional]
# The URL of a media proxy
# Default: null
# Environment variable: MAG_C_MEDIA_PROXY
# networking.media_proxy = ""

# [Optional]
# Whether to proxy remote files through this instance
# Default: false
# Environment variable: MAG_C_PROXY_REMOTE_FILES
# networking.proxy_remote_files = false

# ------------------------------[ RPC CONNECTION ]-----------------------------

# [Optional]
# A type of connection to use for the application's internal RPC
# Possible values: "none", "tcp", "unix"
# Default: "none"
# Environment variable: MAG_C_RPC_CONNECTION_TYPE
# rpc.connection_type = "none"

# [Optional]
# The corresponding bind address (or path for Unix-domain sockets) for the internal RPC
# Default: ""
# Environment variable: MAG_C_RPC_BIND_ADDR
# rpc.bind_addr = ""

# -----------------------------[ CALCKEY FRONTEND ]----------------------------

# [Optional]
# The port of the frontend.
# Default: 4938
# Environment variable: MAG_C_CK_FE_PORT
# calckey_frontend.port = 4938

# ----------------------------------[ DATA ]-----------------------------------

# [REQUIRED]
# An URI pointing to a Postgres database, with a Calckey database
# Environment variables: MAG_C_DATABASE_URL, DATABASE_URL
# data.database_url = "postgres://username:password@db:5432/calckey"

# [REQUIRED]
# An URI pointing to a Redis instance
# Environment variables: MAG_C_REDIS_URL
# data.redis_url = "redis://redis:6379"

# -------------------------------[ FEDERATION ]--------------------------------


# --------------------------------[ BRANDING ]---------------------------------

# [Optional]
# The name of this software
# Default: "magnetar"
# Environment variable: MAG_C_BR_NAME
# branding.name = "magnetar"

# [Optional]
# The version of this software
# Default: <the version the software was compiled with>
# Environment variable: MAG_C_BR_VERSION
# branding.version = "0.1"

# [Optional]
# The homepage of this software
# Default: "https://git.astolfo.cool/natty/magnetar"
# Environment variable: MAG_C_BR_HOMEPAGE
# branding.homepage = "https://git.astolfo.cool/natty/magnetar"

# [Optional]
# The repository of this software
# Default: "https://git.astolfo.cool/natty/magnetar"
# Environment variable: MAG_C_BR_REPOSITORY
# branding.repository = "https://git.astolfo.cool/natty/magnetar"