config.example.yaml

# HTTP API server configuration.
server:
  # IP address or hostname where the server will listen for connections.
  # Alternatively, you can use MIKU_PUSH_SERVER_HOST environment variable to override this value.
  # Default value if not specified: 0.0.0.0
  host: 0.0.0.0
  # Server TCP port.
  # Alternatively, you can use MIKU_PUSH_SERVER_PORT environment variable to override this value.
  # Default value if not specified: 8080
  port: 8080
  # Server static files directory.
  # Alternatively, you can use MIKU_PUSH_SERVER_STATIC_DIR environment variable to override this value.
  # Default value if not specified: dist/assets (which is relative to the executable)
  static_directory: dist/assets
  # URL base path for serving static files.
  # Alternatively, you can use MIKU_PUSH_SERVER_STATIC_BASE_PATH environment variable to override this value.
  # Default value if not specified: /assets
  static_base_path: /assets
  # Server templates files directory.
  # Alternatively, you can use MIKU_PUSH_SERVER_TEMPLATES_DIR environment variable to override this value.
  # Default value if not specified: dist (which is relative to the executable)
  templates_directory: dist

# Logging configuration.
log:
  # Log level.
  # Possible values: trace, debug, info, warn, error.
  # Alternatively, you can use MIKU_PUSH_LOG_LEVEL environment variable to override this value.
  # Default value if not specified: info
  level: info
  # Log file name.
  # It configures the log file name prefix if the output is set to file.
  # For example, if the value is "server", the log file will be named "server.2025-12-11-14.log".
  # Alternatively, you can use MIKU_PUSH_LOG_FILE_PREFIX environment variable to override this value.
  file_prefix: server
  # Log directory.
  # It configures the log directory if the output is set to file.
  # Alternatively, you can use MIKU_PUSH_LOG_DIRECTORY environment variable to override this value.
  # The default log directory is specific by platform if not specified:
  # - Linux: /var/log/io.mikupush.server
  # - macOS: /usr/local/var/log/io.mikupush.server
  # - Windows: %LOCALAPPDATA%\io.mikupush.server\logs
  directory: /var/log/io.mikupush.server
  # JSON log format.
  # If set to true, the log format is JSON.
  # Alternatively, you can use MIKU_PUSH_LOG_JSON environment variable to override this value.
  # Default value if not specified: false
  json: false

# Database configuration (PostgresSQL)
# Note: the effective URL is built as
#   postgresql://<user>:<password>@<host>:<port>/<database>
database:
  # Hostname or IP of the PostgreSQL server.
  # Alternatively, you can use MIKU_PUSH_DATABASE_HOST environment variable to override this value.
  # Default value: localhost
  host: localhost
  # Port of the PostgreSQL server.
  # Alternatively, you can use MIKU_PUSH_DATABASE_PORT environment variable to override this value.
  # Default value: 5432
  port: 5432
  # Name of the database to connect to.
  # Alternatively, you can use MIKU_PUSH_DATABASE_NAME environment variable to override this value.
  # Default value: postgres
  database: postgres
  # Database user.
  # Alternatively, you can use MIKU_PUSH_DATABASE_USER environment variable to override this value.
  # Default value: postgres
  user: postgres
  # Database user password.
  # Alternatively, you can use MIKU_PUSH_DATABASE_PASSWORD environment variable to override this value.
  # Default value: postgres
  password: postgres

# File upload configuration
upload:
  # Maximum allowed upload size in bytes.
  # If not set, or is set unlimited, there is no limit.
  # Alternatively, you can use MIKU_PUSH_UPLOAD_MAX_SIZE environment variable to override this value (number in bytes or "unlimited").
  # Example: 5000000000 for 5GB
  max_size: 5000000000 # 5GB
  # Directory where uploaded files are stored.
  # Can be a relative or absolute path.
  # Default value: data
  directory: data
  # Expiration time for uploaded files in seconds.
  # If not set, files do not expire.
  # Alternatively, you can use MIKU_PUSH_UPLOAD_EXPIRES_IN_SECONDS environment variable to override this value.
  # Example: 604800 for 7 days
  expires_in_seconds: 604800
  # Interval in seconds to check and delete expired files.
  # Alternatively, you can use MIKU_PUSH_UPLOAD_EXPIRATION_CLEANUP_INTERVAL environment variable to override this value.
  # Default value: 3600 (1 hour)
  expiration_cleanup_interval_seconds: 3600

# Debug configuration
debug:
  # Enable debug mode.
  # When enabled, the server will attempt to serve the UI from the Astro development server
  # instead of using the local static files and templates.
  # Alternatively, you can use MIKU_PUSH_DEBUG_ENABLE environment variable to override this value.
  # Default value: false
  enable: false
  # Astro development server URL.
  # This is the URL where the Astro development server is running during development.
  # It is used when debug.enable is true to proxy or redirect UI requests to Astro.
  # Alternatively, you can use MIKU_PUSH_DEBUG_ASTRO_DEV_SERVER environment variable to override this value.
  # Default value: http://localhost:4321/
  astro_dev_server: http://localhost:4321/