OpenMod Plugin Configuration & YAML

[- Alex - 36]

OpenMod Plugin Configuration & YAML
Editing Plugin Settings Without Breaking Production
GGU Public Technical Knowledge Base

Public Knowledge Base:
This article is written for both GGU administrators and the wider server-hosting community. General instructions are platform-neutral where possible; GGU-specific practices are identified separately.

 

Applies To

• OpenMod administrators
• Plugin operators

 

Prerequisites

• Access to the plugin configuration
• Basic YAML familiarity

 

What You’ll Accomplish

Locate, edit, validate, and safely update OpenMod plugin configuration.

 

Where Plugin Configuration Lives

OpenMod uses YAML for configuration. The administrator documentation places plugin-specific configuration under the plugin's directory inside the OpenMod plugins area.

OpenMod/plugins/<plugin-id>/config.yaml

 

YAML Rules That Matter

• Indentation is significant; use spaces consistently.
• Do not mix tabs into indentation.
• Lists normally use `-` entries.
• Quote values when punctuation or YAML parsing could make intent ambiguous.
• Keep a backup before large edits.
• Validate the server after changing a critical configuration.

 

Configuration Updates

Important:
OpenMod's documentation warns that configuration files are not automatically updated when a plugin adds new fields. You may need to add new keys manually or regenerate the file according to the plugin's instructions.

 

Safe Editing Workflow

1. Read the plugin's current release notes or config documentation.
2. Back up the current config.
3. Make one logical change at a time.
4. Preserve indentation and data types.
5. Apply/reload only as required by that plugin/framework.
6. Review console/log output.
7. Test the changed behavior.

 

Regenerating a Configuration

If the plugin author documents that deleting or renaming the configuration causes a fresh default to be generated, preserve the old file first. Regeneration is useful for discovering newly added keys, but blindly deleting a production config can discard important values.

 

Secrets

Do not paste production database passwords, API keys, bot tokens, or other secrets into public troubleshooting posts. If a plugin needs secrets in YAML, restrict file access appropriately and use placeholders in public examples.

 

GGU Implementation Notes

GGU should keep non-secret example configurations in Gitea when useful, but production secrets belong outside public repositories. For in-house plugins, configuration changes should be documented alongside the version that introduced them so other GGU operators can upgrade without guessing.

 

Upstream References

• OpenMod Configuration Files
• OpenMod Developer Configuration

 

Golden Gamers United — Public Technical Knowledge Base
General guidance first. GGU implementation details second.