Skip to content

Commit

Permalink
Format tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@PadowYT2
PadowYT2 committed Aug 19, 2024
1 parent 99667c5 commit 4321a62
Show file tree
Hide file tree
Showing 8 changed files with 89 additions and 89 deletions.
20 changes: 10 additions & 10 deletions community/config/eggs/creating_a_custom_egg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,13 @@ They will then be visible when managing the startup for a server in both the Adm

The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser.

| Variable | Description | Example |
|----------|-------------|---------|
| TZ | Time Zone | `Etc/UTC` |
| STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` |
| SERVER_MEMORY | Memory available for the server in MB | `512` |
| SERVER_IP | Default ip of the server | `127.0.0.1` |
| SERVER_PORT | Primary Server Port | `27015` |
| P_SERVER_LOCATION | Location of the server | `Example City` |
| P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` |
| P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` |
| Variable | Description | Example |
| ------------------------- | ------------------------------------------- | -------------------------------------------------------------- |
| TZ | Time Zone | `Etc/UTC` |
| STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` |
| SERVER_MEMORY | Memory available for the server in MB | `512` |
| SERVER_IP | Default ip of the server | `127.0.0.1` |
| SERVER_PORT | Primary Server Port | `27015` |
| P_SERVER_LOCATION | Location of the server | `Example City` |
| P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` |
| P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` |
66 changes: 33 additions & 33 deletions daemon/0.6/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ If you're seeing more servers than you expected being killed as a result of the
adjustments to the settings below. Please note the configs below are in JSON dot-notation and should be expanded
out into a normal JSON object.

| Setting Path | Default Value | Notes |
| ------------ | ------------- | ----- |
| `enabled` | true | Determines if the throttle (and associated values below) should be used. |
| `kill_at_count` | 5 | The number of warnings that can accumulate for a particular instance before the server process is killed. The decay time below affects how quickly this value is decreased. |
| `decay` | 10 | The number of seconds that a server process must go without triggering a data throttle warning before the throttle count begins decreasing. This loop is processed every 5 seconds and will decrement the throttle count by one when the process goes more than this number of seconds without a data throttle occurring. |
| `bytes` | 30720 | :warning: _(removed in v0.5.5)_ The maximum number of bytes of data that can be output in the defined interval before a warning occurs. |
| `lines` | 1000 | :warning: _(added in v0.5.6)_ The number of lines that can be output by the server process in the defined check interval time. By default, 5,000 lines in ~500ms results in a server process kill. |
| `check_interval_ms` | 100 | The number of milliseconds between the throttle resetting the used bytes or line count. |
| Setting Path | Default Value | Notes |
| ------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enabled` | true | Determines if the throttle (and associated values below) should be used. |
| `kill_at_count` | 5 | The number of warnings that can accumulate for a particular instance before the server process is killed. The decay time below affects how quickly this value is decreased. |
| `decay` | 10 | The number of seconds that a server process must go without triggering a data throttle warning before the throttle count begins decreasing. This loop is processed every 5 seconds and will decrement the throttle count by one when the process goes more than this number of seconds without a data throttle occurring. |
| `bytes` | 30720 | :warning: _(removed in v0.5.5)_ The maximum number of bytes of data that can be output in the defined interval before a warning occurs. |
| `lines` | 1000 | :warning: _(added in v0.5.6)_ The number of lines that can be output by the server process in the defined check interval time. By default, 5,000 lines in ~500ms results in a server process kill. |
| `check_interval_ms` | 100 | The number of milliseconds between the throttle resetting the used bytes or line count. |

Please note that all of the settings above are in the `internals.throttle.X` path. So, `enabled` is actually `internals.throttle.enabled`.

Expand Down Expand Up @@ -94,15 +94,15 @@ The following will stop the daemon, remove the network, and start the daemon aga
```

## Private Registries
| Setting Path | Default Value | Notes |
| ------------ | ------------- | ----- |
| `username` | _none_ | The username to use when connecting to the registry. |
| `password` | _none_ | The password associated with the account. |
| `images` | _none_ | An array of images that are associated with the private registry. |
| `auth` | _none_ | |
| `email` | _none_ | |
| `serveraddress` | _none_ | The address to the server the registry is located on. |
| `key` | _none_ | A pre-generated base64 encoded authentication string. If provided none of the above options are required. |
| Setting Path | Default Value | Notes |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------- |
| `username` | _none_ | The username to use when connecting to the registry. |
| `password` | _none_ | The password associated with the account. |
| `images` | _none_ | An array of images that are associated with the private registry. |
| `auth` | _none_ | |
| `email` | _none_ | |
| `serveraddress` | _none_ | The address to the server the registry is located on. |
| `key` | _none_ | A pre-generated base64 encoded authentication string. If provided none of the above options are required. |

Please note that all of the settings above are in the `docker.registry.X` path. So, `username` is actually `docker.registry.username`.

Expand All @@ -111,26 +111,26 @@ This daemon ships with a very strict security configuration designed to limit ac
a large range of potential attack vectors. However, some users might need to tweak these settings, or are running on
a private instance and are willing to decrease some of the security measures.

| Setting Path | Default Value | Notes |
| ------------ | ------------- | ----- |
| `ipv6` | true | Set this to false to disable IPv6 networking on the pterodactyl0 interface. |
| `internal` | false | Set this to true to prevent any external network access to all containers on the pterodactyl0 interface. |
| `enable_icc` | true | Set this to false to disallow containers to access services running on the host system's non-public IP addresses. Setting this to false does make it impossible to connect (from a container) to MySQL/Redis/etc. running on the host system without using the public IP address. |
| `enable_ip_masquerade` | true | Set this to false to disable IP Masquerading on the pterodactyl0 interface. |
| Setting Path | Default Value | Notes |
| ---------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ipv6` | true | Set this to false to disable IPv6 networking on the pterodactyl0 interface. |
| `internal` | false | Set this to true to prevent any external network access to all containers on the pterodactyl0 interface. |
| `enable_icc` | true | Set this to false to disallow containers to access services running on the host system's non-public IP addresses. Setting this to false does make it impossible to connect (from a container) to MySQL/Redis/etc. running on the host system without using the public IP address. |
| `enable_ip_masquerade` | true | Set this to false to disable IP Masquerading on the pterodactyl0 interface. |

Please note that all of the settings above are in the `docker.policy.network.X` path. So, `ipv6` is actually `docker.policy.network.ipv6`.

## Container Policy
| Setting Path | Default Value | Notes |
| ------------ | ------------- | ----- |
| `tmpfs` | `rw,exec,nosuid,size=50M` | These are the arguments used for mounting a `tmpfs` directory into containers to allow certain programs to run. |
| `log_driver` | none | :warning: This option was **removed** in `v0.6` and is forcibly set to `json-file`. The log driver to use for containers. We default to `none` to mitigate a potential DoS attack vector if a server were to spam log output. |
| `log_opts` | array | |
| `log_opts.max_size` | `5m` | The maximum size of the server output log file created by Docker. |
| `log_opts.max_files` | `1` | The maximum number of files that Docker will create with output from the server. |
| `readonly_root` | true | Determines if the root filesystem of the container should be readonly. |
| `securityopts` | array | An array of security options to apply to a container. The default array is provided below. |
| `cap_drop` | array | An array of linux capabilities to drop from the container (in addition to ones [dropped by docker already](https://docs.docker.com/engine/security/security/#linux-kernel-capabilities). A listing of the default array is below. |
| Setting Path | Default Value | Notes |
| -------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tmpfs` | `rw,exec,nosuid,size=50M` | These are the arguments used for mounting a `tmpfs` directory into containers to allow certain programs to run. |
| `log_driver` | none | :warning: This option was **removed** in `v0.6` and is forcibly set to `json-file`. The log driver to use for containers. We default to `none` to mitigate a potential DoS attack vector if a server were to spam log output. |
| `log_opts` | array | |
| `log_opts.max_size` | `5m` | The maximum size of the server output log file created by Docker. |
| `log_opts.max_files` | `1` | The maximum number of files that Docker will create with output from the server. |
| `readonly_root` | true | Determines if the root filesystem of the container should be readonly. |
| `securityopts` | array | An array of security options to apply to a container. The default array is provided below. |
| `cap_drop` | array | An array of linux capabilities to drop from the container (in addition to ones [dropped by docker already](https://docs.docker.com/engine/security/security/#linux-kernel-capabilities). A listing of the default array is below. |

Please note that all of the settings above are in the `docker.policy.container.X` path. So, `tmpfs` is actually `docker.policy.container.tmpfs`.

Expand Down
16 changes: 8 additions & 8 deletions daemon/0.6/installing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ This specific software is for Pterodactyl v0.7 and **must not be used for Pterod
[[toc]]

## Supported Systems
| Operating System | Version | Supported | Notes |
| ---------------- | ------- | :-------: | ----- |
| **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. |
| | [20.04](/community/installation-guides/daemon/ubuntu2004.html) | :white_check_mark: |
| **CentOS** | [7](/community/installation-guides/daemon/centos7.html) | :warning: | Extra repos are required |
| | [8](/community/installation-guides/daemon/centos8.html) | :white_check_mark: | |
| **Debian** | [9](/community/installation-guides/daemon/debian9.html) | :white_check_mark: | |
| | [10](/community/installation-guides/daemon/debian10.html) | :white_check_mark: | |
| Operating System | Version | Supported | Notes |
| ---------------- | -------------------------------------------------------------- | :----------------: | ----------------------------------------------------------- |
| **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. |
| | [20.04](/community/installation-guides/daemon/ubuntu2004.html) | :white_check_mark: |
| **CentOS** | [7](/community/installation-guides/daemon/centos7.html) | :warning: | Extra repos are required |
| | [8](/community/installation-guides/daemon/centos8.html) | :white_check_mark: | |
| **Debian** | [9](/community/installation-guides/daemon/debian9.html) | :white_check_mark: | |
| | [10](/community/installation-guides/daemon/debian10.html) | :white_check_mark: | |

## System Requirements
In order to run the Daemon you will need a system capable of running Docker containers. Most VPS and almost all
Expand Down
14 changes: 7 additions & 7 deletions guides/php_upgrade.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
This documentation includes instructions for upgrading your system to the latest version of PHP. Please reference the
table below to check what version you need for your version of Pterodactyl.

| Panel Version | PHP Version |
|---------------|---------------|
| 1.0.0 - 1.2.0 | 7.3, 7.4 |
| 1.3.0+ | 7.4, 8.0 |
| 1.8.0+ | 7.4, 8.0, 8.1 |
| 1.11.0 - 1.11.3 | 8.0, 8.1 |
| 1.11.4+ | 8.1, 8.2, 8.3 |
| Panel Version | PHP Version |
| --------------- | ------------- |
| 1.0.0 - 1.2.0 | 7.3, 7.4 |
| 1.3.0+ | 7.4, 8.0 |
| 1.8.0+ | 7.4, 8.0, 8.1 |
| 1.11.0 - 1.11.3 | 8.0, 8.1 |
| 1.11.4+ | 8.1, 8.2, 8.3 |

## Install PHP

Expand Down
Loading

0 comments on commit 4321a62

Please sign in to comment.