Main Configuration

Complete reference for the HyperPerms configuration file. All settings and their effects are documented here.

Configuration File Location

text
mods/com.hyperperms_HyperPerms/config.json

Full Configuration Reference

json
{
  "storage": {
    "type": "json"
  },
  "cache": {
    "enabled": true,
    "maxSize": 10000,
    "expireAfterAccessMinutes": 10
  },
  "defaultGroup": "default",
  "webEditor": {
    "enabled": true,
    "apiUrl": "https://api.hyperperms.com"
  },
  "analytics": {
    "enabled": false,
    "trackChecks": true,
    "trackChanges": true,
    "retentionDays": 90
  },
  "console": {
    "clickableLinksEnabled": true
  }
}

Storage Settings

json
"storage": {
  "type": "json"
}
OptionTypeDefaultDescription
typestring"json"Storage backend type: json, sqlite, or mariadb

See the storage guide for more details.

Cache Settings

json
"cache": {
  "enabled": true,
  "maxSize": 10000,
  "expireAfterAccessMinutes": 10
}
OptionTypeDefaultDescription
enabledbooleantrueEnable permission caching
maxSizeinteger10000Max cached permission results
expireAfterAccessMinutesinteger10Minutes before cached entries expire after last access
Keep caching enabled for optimal performance. The cache is automatically invalidated when permissions change.

Default Group

json
"defaultGroup": "default"
OptionTypeDefaultDescription
defaultGroupstring"default"Default group assigned to new players

Web Editor Settings

json
"webEditor": {
  "enabled": true,
  "apiUrl": "https://api.hyperperms.com"
}
OptionTypeDefaultDescription
enabledbooleantrueEnable the web editor feature
apiUrlstring"https://api.hyperperms.com"Web editor API URL (change for self-hosting)
If you're self-hosting the web editor, change the URL to your own instance. See the self-hosting guide.

Analytics Settings

json
"analytics": {
  "enabled": false,
  "trackChecks": true,
  "trackChanges": true,
  "retentionDays": 90
}
OptionTypeDefaultDescription
enabledbooleanfalseEnable analytics tracking
trackChecksbooleantrueTrack permission check events
trackChangesbooleantrueTrack permission change events
retentionDaysinteger90Number of days to retain analytics data
Analytics requires the SQLite JDBC driver to be installed. See the storage guide for driver installation instructions.

Console Settings

json
"console": {
  "clickableLinksEnabled": true
}
OptionTypeDefaultDescription
clickableLinksEnabledbooleantrueEnable clickable links in console output

Reloading Configuration

After editing the configuration file:

text
/hp reload
Some settings require a full server restart, including:
  • Storage type changes
  • Some performance settings

See Also