pterodactyl/documentation
1
0
Fork 0
mirror of https://github.com/pterodactyl/documentation.git synced 2025-12-12 18:36:04 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #378 from Software-Noob/docs/new-limits

Browse Source 
New PID and installer limits
This commit is contained in:
Dane Everitt 2021-06-23 16:55:54 -07:00 committed by GitHub
commit b223b18004
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
wings/1.0/configuration.md
View File

@ -7,7 +7,7 @@ These are advanced configurations for Wings. You risk breaking Wings and making
you misconfigure something. Proceed only if you know what each configuration value does. you misconfigure something. Proceed only if you know what each configuration value does.
::: :::
You must apply all changes to your Wings `config.yml` file located at `/etc/pterodactyl`. Verify your config file using [Yaml Lint](http://www.yamllint.com/) should you receive errors related to YAML parsing. You must apply all changes to your Wings `config.yml` file located at `/etc/pterodactyl` and restart wings. Verify your config file using [Yaml Lint](http://www.yamllint.com/) should you receive errors related to YAML parsing.
## Private Registries ## Private Registries
@ -72,7 +72,8 @@ You can use these settings to adjust or completely disable throttling.
| decay_interval | 10000 | Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented | | decay_interval | 10000 | Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented |
| stop_grace_period | 15 | Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle | | stop_grace_period | 15 | Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle |
| write_limit | 0 | Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s | | write_limit | 0 | Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s |
| download_limit | 0 | Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s. | | download_limit | 0 | Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s |
| container_pid_limit | 256 | The total number of processes that can be active in a container at any given moment to prevent malicious overloading of the node |
### Example of usage ### Example of usage
@ -86,6 +87,22 @@ throttles:
stop_grace_period: 15 stop_grace_period: 15
``` ```
## Installer Limits
Defines the limits on the installer containers that prevents a server's installation process from unintentionally consuming more resources than expected. This is used in conjunction with the server's defined limits. Whichever value is higher will take precedence in the install containers.
| Setting Key | Default Value | Notes |
| :-------------------- | :-----------: | ----------------------------------------------------------------------------------------------------------- |
| memory | 1024 | The maximum amount of memory install container can use unless server memory limit is higher than this value |
| cpu | 100 | The maximum amount of cpu install container can use unless server cpu limit is higher than this value |
### Example of usage
```yml
installer_limits:
memory: 1024
cpu: 100
```
## Other values ## Other values
More commonly discussed values. View all Wings config values and explanations in [these two files.](https://github.com/pterodactyl/wings/tree/develop/config) More commonly discussed values. View all Wings config values and explanations in [these two files.](https://github.com/pterodactyl/wings/tree/develop/config)