BallStudios/pterodactyl_addon
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

File transfer

Browse Source
This commit is contained in:
BaileyCodes
2026-06-11 20:33:44 -05:00
parent 2cb1d58264
commit b362357bcb
58 changed files with 5096 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/CONFIG.md Normal file
View File

@@ -0,0 +1,60 @@
# Configuration Reference
> **Ball Studios** — https://git.balls.studio/BallStudios/pterodactyl_addon
All settings are in `config/advanced-admin.php`. Many can be overridden via `.env`.
## Network Traffic Dashboard
| Key | Default | `.env` Override | Description |
|---|---|---|---|
| `network.enabled` | `true` | `ADDON_NETWORK_ENABLED` | Enable/disable module |
| `network.collection_interval_seconds` | `10` | `ADDON_NETWORK_INTERVAL` | Seconds between metrics collection |
| `network.iptables_enabled` | `false` | `ADDON_NETWORK_IPTABLES` | Enable port-level iptables collection |
| `network.retention.raw` | `1` | `ADDON_NETWORK_RETENTION_RAW` | Raw data retention (days) |
| `network.retention.5m` | `7` | `ADDON_NETWORK_RETENTION_5M` | 5-min downsampled retention (days) |
| `network.retention.1h` | `30` | `ADDON_NETWORK_RETENTION_1H` | Hourly downsampled retention (days) |
| `network.retention.1d` | `365` | `ADDON_NETWORK_RETENTION_1D` | Daily downsampled retention (days) |
| `network.rate_limit_per_minute` | `12` | `ADDON_NETWORK_RATE_LIMIT` | Live endpoint rate limit |
## Role-Based Permissions
| Key | Default | Description |
|---|---|---|
| `roles.enabled` | `true` | Enable/disable module |
| `roles.max_roles_per_server` | `0` | 0 = unlimited |
| `roles.warn_on_delete_in_use` | `true` | Warn before deleting assigned role |
| `roles.dangerous_permissions` | See config | Permissions that trigger UI warning |
| `roles.write_rate_limit` | `30` | Admin write operations per minute |
## File Revision History
| Key | Default | `.env` Override | Description |
|---|---|---|---|
| `revisions.enabled` | `true` | `ADDON_REVISIONS_ENABLED` | Enable/disable module |
| `revisions.storage_path` | `addons/revisions` | `ADDON_REVISIONS_PATH` | Storage path under `storage/app/` |
| `revisions.max_file_size` | `10485760` (10 MB) | `ADDON_REVISIONS_MAX_FILE_SIZE` | Max file size to track (bytes) |
| `revisions.max_revisions_per_file` | `50` | `ADDON_REVISIONS_MAX_PER_FILE` | Max revisions per file |
| `revisions.max_storage_per_server` | `524288000` (500 MB) | `ADDON_REVISIONS_MAX_STORAGE` | Max storage per server |
| `revisions.retention_days` | `90` | `ADDON_REVISIONS_RETENTION_DAYS` | Delete revisions older than N days |
| `revisions.excluded_patterns` | See config | — | File glob patterns to never track |
### Default Excluded Patterns
```
.env, *.env, *.key, *.pem, *.p12, *.pfx, *.crt, *.cer, *.jks
secrets.yml, secrets.yaml, *secret*, *password*, *token*
*.sql, *.sql.gz, *.bak, *.backup, *.dump
*.zip, *.tar, *.tar.gz, *.tar.bz2, *.7z, *.rar
```
## Console Autocomplete
| Key | Default | `.env` Override | Description |
|---|---|---|---|
| `console.enabled` | `true` | `ADDON_CONSOLE_ENABLED` | Enable/disable module |
| `console.autocomplete_rate_limit` | `60` | `ADDON_CONSOLE_RATE_LIMIT` | Requests per minute per user |
| `console.player_cache_ttl_minutes` | `30` | `ADDON_CONSOLE_PLAYER_TTL` | Player cache expiry (minutes) |
| `console.max_suggestions` | `10` | `ADDON_CONSOLE_MAX_SUGGESTIONS` | Max suggestions returned |
| `console.patterns.join.*` | See config | — | Regex patterns for player join |
| `console.patterns.leave.*` | See config | — | Regex patterns for player leave |