documentation/wings/1.0/configuration.md

Additional Configuration

toc

::: warning These are advanced configurations for Wings. You risk breaking Wings and making containers unusable if 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 should you receive errors related to YAML parsing.

Private Registries

You can use these settings to authenticate against (private) docker registries when pulling images.

Available Keys

Setting Key	Default Value	Notes
name	null	Registry address
username	null	Registry username
password	null	Registry password

Example of usage

docker:
  registries:
    registry.example.com:
      username: "registryusername"
      password: "registrypassword"

Custom Network Interfaces

You can change the network interface that Wings uses for all containers by editing the network name; it is by default set to pterodactyl_nw. For example, to enable Docker host mode change the network name to host.

::: warning Changing network mode to host grants Pterodactyl direct access to all machine interfaces and Panel users can bind to any IP or Port even if it's not allocated to their container. You will lose all benefits of Docker network isolation. It is not recommended for public installations that are hosting other users' servers. :::

Example of usage

docker:
  network:
    name: host

After making changes, the following commands will stop the Wings, remove the Pterodactyl network, and start the Wings again. Run at your own risk. systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings

Enabling Cloudflare proxy

Cloudflare proxying of the Wings isn't beneficial since users will be connecting to the machine directly and bypassing any Cloudflare protection. As such, your Node machine IP will still be exposed.

To enable Cloudflare proxy, you must change the Wings port to one of the Cloudflare HTTPS ports, such as 8443, because Cloudflare only supports HTTP on port 8080. Select your Node in the Admin Panel, and on the settings tab, change the port.

You are unable to proxy the SFTP port through Cloudflare unless you have their enterprise plan.

Throttles Limits

You can use these settings to adjust or completely disable throttling.

Setting Key	Default Value	Notes
enabled	true	Whether or not the throttler is enabled
lines	2000	Total lines that can be output in a given line_reset_interval period
maximum_trigger_count	5	Amount of times throttle limit can be triggered before the server will be stopped
line_reset_interval	100	The amount of time after which the number of lines processed is reset to 0
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
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.

Example of usage

throttles:
  enabled: true
  lines: 2000
  maximum_trigger_count: 5
  line_reset_interval: 100
  decay_interval: 10000
  stop_grace_period: 15

Other values

More commonly discussed values. View all Wings config values and explanations in these two files.

Setting Key	Default Value	Notes
debug	false	Force Wings to run in debug mode
tmpfs_size	100	The size of the /tmp directory in MB when mounted into a container
websocket_log_count	150	The number of lines to display in the console
detect_clean_exit_as_crash	true	Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button
(crash detection) timeout	60	Timeout between server crashes that will not cause the server to be automatically restarted