Skip to main content

Config YML Reference

The main configuration file is located at plugins/ZyveraWeb/config.yml. It uses the YAML format and is divided into several sections.

Full Schema

host: "<ip-address>"
port: <port-number>

api:
  cors-origins:
    - "<origin>"

rate-limit:
  placeholder:
    requests: <number>
    per: <duration>
  players:
    requests: <number>
    per: <duration>

sites:
  - domain: "<domain>"
    dir: "<folder>"                 # OR
    proxy: "<url>"
    ssl:                            # optional per-site HTTPS
      cert: "<cert-filename>"
      key: "<key-filename>"
    rate-limit:                     # optional per-site rate limit
      requests: <number>
      per: <duration>
  - domain: "<domain>"
    ...

api Settings

Controls API security features.

Setting Default Description
api.cors-origins Auto (localhost + site domains) List of allowed CORS origins. By default, only localhost and domains listed under sites are accepted. Override with specific origins.

Sections Overview

Section Description
host IP address to bind to
port Port the web server listens on
api CORS origins
rate-limit Per-endpoint rate limiting rules
sites Virtual host definitions

Complete Default Example

host: "0.0.0.0"
port: 8080

api:
  cors-origins:

rate-limit:
  placeholder:
    requests: 180
    per: 30s
  players:
    requests: 200
    per: 20s

sites:
  - domain: ""
    dir: "site/default"

Validation Rules

The plugin validates the config at startup. If validation fails, the plugin disables itself with an error message:

  • Port: Must be between 1 and 65535
  • Host: Cannot be blank
  • Rate limits: Both sections (placeholder, players) must have requests > 0 and a valid per duration

No comments to display

Back to top