ProVouchers

config.yml Reference

Every server-wide setting, annotated.

plugins/ProVouchers/config.yml holds server-wide settings. Per-voucher and per-code options live in their own files (see Voucher Reference and Code Reference).

The full file

config.yml
storage:
  # Backend: sqlite | mysql | mariadb | postgres
  # SQLite is file-based and needs no extra setup; the others connect to a server.
  backend: sqlite
  # The settings below are used only by the networked backends.
  host: localhost
  port: 5432
  database: provouchers
  username: provouchers
  password: ""
  pool-size: 10

anti-dupe:
  # When a duplicate voucher is detected on redeem, remove the item instead of
  # returning it to the player.
  remove-on-discovery: true

metrics:
  # Submit anonymous usage statistics through Strata (bStats and FastStats).
  # Set to false to opt out entirely.
  enabled: true

storage

See Storage and Database for full details.

KeyDefaultNotes
storage.backendsqlitesqlite, mysql, mariadb, or postgres.
storage.hostlocalhostNetworked backends only.
storage.port5432Networked backends only. Default 3306 for MySQL/MariaDB.
storage.databaseprovouchersDatabase name.
storage.usernameprovouchersDatabase user.
storage.password""Database password.
storage.pool-size10Max pooled connections.

An unknown backend value falls back to SQLite with a warning in the console.

anti-dupe

See Anti-Dupe and Anti-Exploit.

KeyDefaultNotes
anti-dupe.remove-on-discoverytrueRemove a duplicate voucher when caught, instead of returning it.

metrics

KeyDefaultNotes
metrics.enabledtrueSubmit anonymous usage stats through Strata (bStats and FastStats). Set to false to opt out.

Metrics report only aggregate, non-identifying data (such as which storage backend is in use and how many vouchers are loaded). They never include player data. See Metrics and Telemetry for the full list of charts and how to opt out.

Applying changes

config.yml is read on startup. After editing it, restart the server (or reload the server) for storage and metrics changes to take effect. Voucher and code files, by contrast, are reloaded live with /voucher reload.

On this page