From 6fecfea21dc28399d36c184327cde2ebc09625be Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 09:48:46 +0200 Subject: [PATCH 01/19] Update config.js --- .vuepress/config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/.vuepress/config.js b/.vuepress/config.js index 736bfcee3..b6ce4b174 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -107,6 +107,7 @@ module.exports = { children: [ '/community/config/nodes/add_node.md', '/community/tutorials/artisan.md', + '/community/tutorials/dockerized-versions.md', ], }, { From b12d075a7f7c77ce464d325831f0b70408e1fc1a Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 09:49:51 +0200 Subject: [PATCH 02/19] Create dockerized-versions.md --- community/tutorials/dockerized-versions.md | 76 ++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 community/tutorials/dockerized-versions.md diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md new file mode 100644 index 000000000..4c1ace32e --- /dev/null +++ b/community/tutorials/dockerized-versions.md @@ -0,0 +1,76 @@ +# Pterodactyl Panel - Docker Image +`ghcr.io/pterodactyl/panel` is a ready to use docker image for the panel. + +## Requirements +The docker image requires some additional software to function. The software can either be provided in other containers (see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) as an example) or as existing instances. + +A mysql database is required. We recommend the stock [MariaDB Image](https://hub.docker.com/_/mariadb/) image if you prefer to run it in a docker container. As a non-containerized option we recommend mariadb. + +A caching software is required as well. We recommend the stock [Redis Image](https://hub.docker.com/_/redis/) image. You can choose any of the [supported options](#cache-drivers). + +You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file. + +## Setup + +Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example. + +After the startup is complete you'll need to create a user. +If you are running the docker container without docker-compose, use: +``` +docker exec -it php artisan p:user:make +``` +If you are using docker compose use +``` +docker-compose exec panel php artisan p:user:make +``` + +## Environment Variables +There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option. + +Note: If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so Certificates can be generated. + +| Variable | Description | Required | +| ------------------- | ------------------------------------------------------------------------------ | -------- | +| `APP_URL` | The URL the panel will be reachable with (including protocol) | yes | +| `APP_TIMEZONE` | The timezone to use for the panel | yes | +| `LE_EMAIL` | The email used for letsencrypt certificate generation | yes | +| `DB_HOST` | The host of the mysql instance | yes | +| `DB_PORT` | The port of the mysql instance | yes | +| `DB_DATABASE` | The name of the mysql database | yes | +| `DB_USERNAME` | The mysql user | yes | +| `DB_PASSWORD` | The mysql password for the specified user | yes | +| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes | +| `SESSION_DRIVER` | | yes | +| `QUEUE_DRIVER` | | yes | +| `REDIS_HOST` | The hostname or IP address of the redis database | yes | +| `REDIS_PASSWORD` | The password used to secure the redis database | maybe | +| `REDIS_PORT` | The port the redis database is using on the host | maybe | +| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes | +| `MAIL_FROM` | The email that should be used as the sender email | yes | +| `MAIL_HOST` | The host of your mail driver instance | maybe | +| `MAIL_PORT` | The port of your mail driver instance | maybe | +| `MAIL_USERNAME` | The username for your mail driver | maybe | +| `MAIL_PASSWORD` | The password for your mail driver | maybe | + + +### Cache drivers +You can choose between different cache drivers depending on what you prefer. +We recommend redis when using docker as it can be started in a container easily. + +| Driver | Description | Required variables | +| -------- | ------------------------------------ | ------------------------------------------------------ | +| redis | host where redis is running | `REDIS_HOST` | +| redis | port redis is running on | `REDIS_PORT` | +| redis | redis database password | `REDIS_PASSWORD` | + +### Mail drivers +You can choose between different mail drivers according to your needs. +Every driver requires `MAIL_FROM` to be set. + +| Driver | Description | Required variables | +| -------- | ------------------------------------ | ------------------------------------------------------------- | +| mail | uses the installed php mail | | +| mandrill | [Mandrill](http://www.mandrill.com/) | `MAIL_USERNAME` | +| postmark | [Postmark](https://postmarkapp.com/) | `MAIL_USERNAME` | +| mailgun | [Mailgun](https://www.mailgun.com/) | `MAIL_USERNAME`, `MAIL_HOST` | +| smtp | Any SMTP server can be configured | `MAIL_USERNAME`, `MAIL_HOST`, `MAIL_PASSWORD`, `MAIL_PORT` | From 4a6103d6b74e731bfcc33418b6d076b9fca4557e Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 09:59:25 +0200 Subject: [PATCH 03/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index 4c1ace32e..bb69c0a06 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -1,4 +1,4 @@ -# Pterodactyl Panel - Docker Image +# Panel Image `ghcr.io/pterodactyl/panel` is a ready to use docker image for the panel. ## Requirements @@ -11,7 +11,6 @@ A caching software is required as well. We recommend the stock [Redis Image](htt You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file. ## Setup - Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example. After the startup is complete you'll need to create a user. @@ -69,8 +68,23 @@ Every driver requires `MAIL_FROM` to be set. | Driver | Description | Required variables | | -------- | ------------------------------------ | ------------------------------------------------------------- | -| mail | uses the installed php mail | | | mandrill | [Mandrill](http://www.mandrill.com/) | `MAIL_USERNAME` | | postmark | [Postmark](https://postmarkapp.com/) | `MAIL_USERNAME` | | mailgun | [Mailgun](https://www.mailgun.com/) | `MAIL_USERNAME`, `MAIL_HOST` | | smtp | Any SMTP server can be configured | `MAIL_USERNAME`, `MAIL_HOST`, `MAIL_PASSWORD`, `MAIL_PORT` | + +# Wings Image +`ghcr.io/pterodactyl/wings` is a ready to use docker image for wings. + +## Requirements +The docker image doesn't require any additional software to function. See the [docker-compose.yml](https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml) as an example) or as existing instances. + +## Environment Variables +There are some environment variables to configure wings, see the following table for details on each available option. + +| Variable | Description | Required | +| ------------------- | ------------------------------------------------------------------------------ | -------- | +| `TZ` | The timezone to use for wings | yes | +| `WINGS_UID` | The UID of the wings user | yes | +| `WINGS_GID` | The GID of the wings user | yes | +| `WINGS_USERNAME` | The username of the wings user | yes | From 2e74c1d0c267de0a6f1f8cdef9451df5d7cccf7d Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 10:04:12 +0200 Subject: [PATCH 04/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index bb69c0a06..2d42414e5 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -26,7 +26,7 @@ docker-compose exec panel php artisan p:user:make ## Environment Variables There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option. -Note: If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so Certificates can be generated. +::: warning If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so certificates can be generated. ::: | Variable | Description | Required | | ------------------- | ------------------------------------------------------------------------------ | -------- | @@ -79,6 +79,8 @@ Every driver requires `MAIL_FROM` to be set. ## Requirements The docker image doesn't require any additional software to function. See the [docker-compose.yml](https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml) as an example) or as existing instances. +::: warning If your panel uses SSL your wings need to use SSL as well. Make sure you generated and provided the needed certificates in that case. ::: + ## Environment Variables There are some environment variables to configure wings, see the following table for details on each available option. From 9ae444dad4d3e135fc20c0905a46c42c311e03ac Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 10:26:46 +0200 Subject: [PATCH 05/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 88 ++++++++++++++-------- 1 file changed, 57 insertions(+), 31 deletions(-) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index 2d42414e5..f7db40c8d 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -28,39 +28,65 @@ There are multiple environment variables to configure the panel when not providi ::: warning If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so certificates can be generated. ::: -| Variable | Description | Required | -| ------------------- | ------------------------------------------------------------------------------ | -------- | -| `APP_URL` | The URL the panel will be reachable with (including protocol) | yes | -| `APP_TIMEZONE` | The timezone to use for the panel | yes | -| `LE_EMAIL` | The email used for letsencrypt certificate generation | yes | -| `DB_HOST` | The host of the mysql instance | yes | -| `DB_PORT` | The port of the mysql instance | yes | -| `DB_DATABASE` | The name of the mysql database | yes | -| `DB_USERNAME` | The mysql user | yes | -| `DB_PASSWORD` | The mysql password for the specified user | yes | -| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes | -| `SESSION_DRIVER` | | yes | -| `QUEUE_DRIVER` | | yes | -| `REDIS_HOST` | The hostname or IP address of the redis database | yes | -| `REDIS_PASSWORD` | The password used to secure the redis database | maybe | -| `REDIS_PORT` | The port the redis database is using on the host | maybe | -| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes | -| `MAIL_FROM` | The email that should be used as the sender email | yes | -| `MAIL_HOST` | The host of your mail driver instance | maybe | -| `MAIL_PORT` | The port of your mail driver instance | maybe | -| `MAIL_USERNAME` | The username for your mail driver | maybe | -| `MAIL_PASSWORD` | The password for your mail driver | maybe | - +| Variable | Description | Required | +| -------------------- | ------------------------------------------------------------------------------ | -------- | +| `APP_URL` | The URL the panel will be reachable with (including protocol) | yes | +| `APP_TIMEZONE` | The timezone to use for the panel | yes | +| `LE_EMAIL` | The email used for letsencrypt certificate generation | maybe | +| `DB_HOST` | The host of the mysql instance | yes | +| `DB_PORT` | The port of the mysql instance | yes | +| `DB_DATABASE` | The name of the mysql database | yes | +| `DB_USERNAME` | The mysql user | yes | +| `DB_PASSWORD` | The mysql password for the specified user | yes | +| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes | +| `SESSION_DRIVER` | The session driver (see [Session drivers](#session-drivers) for detais) | yes | +| `QUEUE_DRIVER` | The queue driver (see [Queue drivers](#queue-drivers) for detais) | yes | +| `REDIS_HOST` | The hostname or IP address of the redis database | maybe | +| `REDIS_PORT` | The port the redis database is using on the host | maybe | +| `REDIS_PASSWORD` | The password used to secure the redis database | maybe | +| `MEMCACHED_HOST` | The hostname or IP address of memcached | maybe | +| `MEMCACHED_PORT` | The port of memcached | maybe | +| `MEMCACHED_USERNAME` | The memcached user | maybe | +| `MEMCACHED_PASSWORD` | The memcached password for the specified user | maybe | +| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes | +| `MAIL_FROM` | The email that should be used as the sender email | yes | +| `MAIL_HOST` | The host of your mail driver instance | maybe | +| `MAIL_PORT` | The port of your mail driver instance | maybe | +| `MAIL_USERNAME` | The username for your mail driver | maybe | +| `MAIL_PASSWORD` | The password for your mail driver | maybe | ### Cache drivers You can choose between different cache drivers depending on what you prefer. -We recommend redis when using docker as it can be started in a container easily. - -| Driver | Description | Required variables | -| -------- | ------------------------------------ | ------------------------------------------------------ | -| redis | host where redis is running | `REDIS_HOST` | -| redis | port redis is running on | `REDIS_PORT` | -| redis | redis database password | `REDIS_PASSWORD` | +We recommend `redis` when using docker as it can be started in a container easily. + +| Driver | Description | Required variables | +| --------- | ----------------------------------- | ------------------------------------------------------------------------------ | +| redis | [Redis](https://redis.io/) | `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` | +| database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | +| memcached | [Memcached](https://memcached.org/) | `MEMCACHED_HOST`, `MEMCACHED_PORT`, `MEMCACHED_USERNAME`, `MEMCACHED_PASSWORD` | +| file | Filesystem | | + +### Session drivers +You can choose between different session drivers depending on what you prefer. +We recommend `redis` when using docker as it can be started in a container easily. + +| Driver | Description | Required variables | +| --------- | ----------------------------------- | ------------------------------------------------------------------------------ | +| redis | [Redis](https://redis.io/) | `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` | +| database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | +| memcached | [Memcached](https://memcached.org/) | `MEMCACHED_HOST`, `MEMCACHED_PORT`, `MEMCACHED_USERNAME`, `MEMCACHED_PASSWORD` | +| file | Filesystem | | +| cookie | Cookies | | + +### Queue drivers +You can choose between different queue drivers depending on what you prefer. +We recommend `redis` when using docker as it can be started in a container easily. + +| Driver | Description | Required variables | +| --------- | ----------------------------------- | ----------------------------------------------------------------- | +| redis | [Redis](https://redis.io/) | `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` | +| database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | +| sync | Run tasks synchronously | | ### Mail drivers You can choose between different mail drivers according to your needs. @@ -77,7 +103,7 @@ Every driver requires `MAIL_FROM` to be set. `ghcr.io/pterodactyl/wings` is a ready to use docker image for wings. ## Requirements -The docker image doesn't require any additional software to function. See the [docker-compose.yml](https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml) as an example) or as existing instances. +The docker image doesn't require any additional software to function. See the [docker-compose.yml](https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml) as an example. ::: warning If your panel uses SSL your wings need to use SSL as well. Make sure you generated and provided the needed certificates in that case. ::: From 8bb2c1eb5ee52152009bbb4e92664e6228395ad3 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 11:22:57 +0200 Subject: [PATCH 06/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 43 +++++++++++++++++----- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index f7db40c8d..62968b310 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -1,3 +1,8 @@ +::: warning +To use the dockerized versions of Pterodactyl you need to install Docker! +For a quick start you can run `curl -sSL https://get.docker.com/ | CHANNEL=stable bash`. For more information refer to the official [Docker documentation](https://docs.docker.com/engine/install/). +::: + # Panel Image `ghcr.io/pterodactyl/panel` is a ready to use docker image for the panel. @@ -9,18 +14,27 @@ A mysql database is required. We recommend the stock [MariaDB Image](https://hub A caching software is required as well. We recommend the stock [Redis Image](https://hub.docker.com/_/redis/) image. You can choose any of the [supported options](#cache-drivers). You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file. +If using the docker-compose file the location of a custom `.env` file would be `/srv/pterodactyl/var/.env`. ## Setup -Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example. - -After the startup is complete you'll need to create a user. -If you are running the docker container without docker-compose, use: -``` -docker exec -it php artisan p:user:make -``` -If you are using docker compose use +Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). +```bash +## If you are using docker compose +wget -O docker-compose.yml https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml +docker-compose up -d + +## If you are running the docker container without docker compose +# Start the containers of the dependencies +docker create -it --name panel ghcr.io/pterodactyl/panel ``` + +After the startup is complete you'll need to create a panel user. +```bash +# If you are using docker compose docker-compose exec panel php artisan p:user:make + +# If you are running the docker container without docker compose +docker exec -it panel php artisan p:user:make ``` ## Environment Variables @@ -31,7 +45,7 @@ There are multiple environment variables to configure the panel when not providi | Variable | Description | Required | | -------------------- | ------------------------------------------------------------------------------ | -------- | | `APP_URL` | The URL the panel will be reachable with (including protocol) | yes | -| `APP_TIMEZONE` | The timezone to use for the panel | yes | +| `APP_TIMEZONE` | The [timezone](http://php.net/manual/en/timezones.php) to use for the panel | yes | | `LE_EMAIL` | The email used for letsencrypt certificate generation | maybe | | `DB_HOST` | The host of the mysql instance | yes | | `DB_PORT` | The port of the mysql instance | yes | @@ -107,6 +121,17 @@ The docker image doesn't require any additional software to function. See the [d ::: warning If your panel uses SSL your wings need to use SSL as well. Make sure you generated and provided the needed certificates in that case. ::: +## Setup +Start the docker container. +```bash +## If you are using docker compose +wget -O docker-compose.yml https://github.com/pterodactyl/wings/blob/evelop/docker-compose.example.yml +docker-compose up -d + +## If you are running the docker container without docker compose +docker create -it --name wings ghcr.io/pterodactyl/wings +``` + ## Environment Variables There are some environment variables to configure wings, see the following table for details on each available option. From 9fc1837cb1185cb4f44950561ad2fbc1ab570745 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 11:25:14 +0200 Subject: [PATCH 07/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index 62968b310..ab7dbb861 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -1,3 +1,5 @@ +[[toc]] + ::: warning To use the dockerized versions of Pterodactyl you need to install Docker! For a quick start you can run `curl -sSL https://get.docker.com/ | CHANNEL=stable bash`. For more information refer to the official [Docker documentation](https://docs.docker.com/engine/install/). From 0109508efc145bf21839b22814db3a756fc4af5f Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 13:17:53 +0200 Subject: [PATCH 08/19] Update dockerized-versions.md --- community/tutorials/dockerized-versions.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/community/tutorials/dockerized-versions.md b/community/tutorials/dockerized-versions.md index ab7dbb861..e0d150daa 100644 --- a/community/tutorials/dockerized-versions.md +++ b/community/tutorials/dockerized-versions.md @@ -86,7 +86,7 @@ We recommend `redis` when using docker as it can be started in a container easil You can choose between different session drivers depending on what you prefer. We recommend `redis` when using docker as it can be started in a container easily. -| Driver | Description | Required variables | +| Driver | Description | Required variables | | --------- | ----------------------------------- | ------------------------------------------------------------------------------ | | redis | [Redis](https://redis.io/) | `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` | | database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | @@ -98,7 +98,7 @@ We recommend `redis` when using docker as it can be started in a container easil You can choose between different queue drivers depending on what you prefer. We recommend `redis` when using docker as it can be started in a container easily. -| Driver | Description | Required variables | +| Driver | Description | Required variables | | --------- | ----------------------------------- | ----------------------------------------------------------------- | | redis | [Redis](https://redis.io/) | `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` | | database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | @@ -127,7 +127,7 @@ The docker image doesn't require any additional software to function. See the [d Start the docker container. ```bash ## If you are using docker compose -wget -O docker-compose.yml https://github.com/pterodactyl/wings/blob/evelop/docker-compose.example.yml +wget -O docker-compose.yml https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml docker-compose up -d ## If you are running the docker container without docker compose From f5bef691ef4da7a9a171dfabaacb48f37b449f34 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 13:18:43 +0200 Subject: [PATCH 09/19] Update config.js --- .vuepress/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vuepress/config.js b/.vuepress/config.js index b6ce4b174..81e1b17ef 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -107,7 +107,6 @@ module.exports = { children: [ '/community/config/nodes/add_node.md', '/community/tutorials/artisan.md', - '/community/tutorials/dockerized-versions.md', ], }, { @@ -176,6 +175,7 @@ module.exports = { children: [ '/tutorials/mysql_setup.md', '/tutorials/creating_ssl_certificates.md', + '/tutorials/dockerized-versions.md', ], }, { From 34f3341b8536985f3bd0774fde02e69fe6afa2ee Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 13:21:14 +0200 Subject: [PATCH 10/19] Rename community/tutorials/dockerized-versions.md to tutorials/dockerized-versions.md --- {community/tutorials => tutorials}/dockerized-versions.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {community/tutorials => tutorials}/dockerized-versions.md (100%) diff --git a/community/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md similarity index 100% rename from community/tutorials/dockerized-versions.md rename to tutorials/dockerized-versions.md From c1e1f58a5ead2169bed19d359869934515f55e33 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 13:28:25 +0200 Subject: [PATCH 11/19] Update dockerized-versions.md --- tutorials/dockerized-versions.md | 34 ++++++++++++++++---------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index e0d150daa..d6fadc912 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -1,3 +1,4 @@ +# Dockerized versions [[toc]] ::: warning @@ -5,10 +6,10 @@ To use the dockerized versions of Pterodactyl you need to install Docker! For a quick start you can run `curl -sSL https://get.docker.com/ | CHANNEL=stable bash`. For more information refer to the official [Docker documentation](https://docs.docker.com/engine/install/). ::: -# Panel Image +## Panel Image `ghcr.io/pterodactyl/panel` is a ready to use docker image for the panel. -## Requirements +### Requirements The docker image requires some additional software to function. The software can either be provided in other containers (see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) as an example) or as existing instances. A mysql database is required. We recommend the stock [MariaDB Image](https://hub.docker.com/_/mariadb/) image if you prefer to run it in a docker container. As a non-containerized option we recommend mariadb. @@ -18,15 +19,14 @@ A caching software is required as well. We recommend the stock [Redis Image](htt You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file. If using the docker-compose file the location of a custom `.env` file would be `/srv/pterodactyl/var/.env`. -## Setup +### Setup Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). ```bash -## If you are using docker compose +# If you are using docker compose wget -O docker-compose.yml https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml docker-compose up -d -## If you are running the docker container without docker compose -# Start the containers of the dependencies +# If you are running the docker container without docker compose docker create -it --name panel ghcr.io/pterodactyl/panel ``` @@ -39,7 +39,7 @@ docker-compose exec panel php artisan p:user:make docker exec -it panel php artisan p:user:make ``` -## Environment Variables +### Environment Variables There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option. ::: warning If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so certificates can be generated. ::: @@ -71,7 +71,7 @@ There are multiple environment variables to configure the panel when not providi | `MAIL_USERNAME` | The username for your mail driver | maybe | | `MAIL_PASSWORD` | The password for your mail driver | maybe | -### Cache drivers +#### Cache drivers You can choose between different cache drivers depending on what you prefer. We recommend `redis` when using docker as it can be started in a container easily. @@ -82,7 +82,7 @@ We recommend `redis` when using docker as it can be started in a container easil | memcached | [Memcached](https://memcached.org/) | `MEMCACHED_HOST`, `MEMCACHED_PORT`, `MEMCACHED_USERNAME`, `MEMCACHED_PASSWORD` | | file | Filesystem | | -### Session drivers +#### Session drivers You can choose between different session drivers depending on what you prefer. We recommend `redis` when using docker as it can be started in a container easily. @@ -94,7 +94,7 @@ We recommend `redis` when using docker as it can be started in a container easil | file | Filesystem | | | cookie | Cookies | | -### Queue drivers +#### Queue drivers You can choose between different queue drivers depending on what you prefer. We recommend `redis` when using docker as it can be started in a container easily. @@ -104,7 +104,7 @@ We recommend `redis` when using docker as it can be started in a container easil | database | MySQL database | `DB_HOST`, `DB_PORT`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD` | | sync | Run tasks synchronously | | -### Mail drivers +#### Mail drivers You can choose between different mail drivers according to your needs. Every driver requires `MAIL_FROM` to be set. @@ -115,26 +115,26 @@ Every driver requires `MAIL_FROM` to be set. | mailgun | [Mailgun](https://www.mailgun.com/) | `MAIL_USERNAME`, `MAIL_HOST` | | smtp | Any SMTP server can be configured | `MAIL_USERNAME`, `MAIL_HOST`, `MAIL_PASSWORD`, `MAIL_PORT` | -# Wings Image +## Wings Image `ghcr.io/pterodactyl/wings` is a ready to use docker image for wings. -## Requirements +### Requirements The docker image doesn't require any additional software to function. See the [docker-compose.yml](https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml) as an example. ::: warning If your panel uses SSL your wings need to use SSL as well. Make sure you generated and provided the needed certificates in that case. ::: -## Setup +### Setup Start the docker container. ```bash -## If you are using docker compose +# If you are using docker compose wget -O docker-compose.yml https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml docker-compose up -d -## If you are running the docker container without docker compose +# If you are running the docker container without docker compose docker create -it --name wings ghcr.io/pterodactyl/wings ``` -## Environment Variables +### Environment Variables There are some environment variables to configure wings, see the following table for details on each available option. | Variable | Description | Required | From 32b0b15464a6d27f86f61f06d78a4d63ec033f59 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 14:57:32 +0200 Subject: [PATCH 12/19] Use raw links for wget --- tutorials/dockerized-versions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index d6fadc912..11fb2e60e 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -23,7 +23,7 @@ If using the docker-compose file the location of a custom `.env` file would be ` Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). ```bash # If you are using docker compose -wget -O docker-compose.yml https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml +wget -O docker-compose.yml https://raw.githubusercontent.com/pterodactyl/panel/1.0-develop/docker-compose.example.yml docker-compose up -d # If you are running the docker container without docker compose @@ -127,7 +127,7 @@ The docker image doesn't require any additional software to function. See the [d Start the docker container. ```bash # If you are using docker compose -wget -O docker-compose.yml https://github.com/pterodactyl/wings/blob/develop/docker-compose.example.yml +wget -O docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wings/develop/docker-compose.example.yml docker-compose up -d # If you are running the docker container without docker compose From 050da5d1964093f18109dc98bc6001a1f91d87f2 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 23 Oct 2023 15:44:01 +0200 Subject: [PATCH 13/19] use curl instead of wget --- tutorials/dockerized-versions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index 11fb2e60e..a4d0a5d5d 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -23,7 +23,7 @@ If using the docker-compose file the location of a custom `.env` file would be ` Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). ```bash # If you are using docker compose -wget -O docker-compose.yml https://raw.githubusercontent.com/pterodactyl/panel/1.0-develop/docker-compose.example.yml +curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/panel/1.0-develop/docker-compose.example.yml docker-compose up -d # If you are running the docker container without docker compose @@ -127,7 +127,7 @@ The docker image doesn't require any additional software to function. See the [d Start the docker container. ```bash # If you are using docker compose -wget -O docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wings/develop/docker-compose.example.yml +curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wings/develop/docker-compose.example.yml docker-compose up -d # If you are running the docker container without docker compose From e92aa89a722414fa82274d5ba2475abc58e5ec6b Mon Sep 17 00:00:00 2001 From: Boy132 Date: Fri, 3 Nov 2023 13:23:29 +0100 Subject: [PATCH 14/19] explain node setup --- tutorials/dockerized-versions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index a4d0a5d5d..c90171377 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -134,6 +134,8 @@ docker-compose up -d docker create -it --name wings ghcr.io/pterodactyl/wings ``` +After the startup is complete you can follow the [normal wings setup guide](/wings/1.0/installing.md#configure) to create a new node. + ### Environment Variables There are some environment variables to configure wings, see the following table for details on each available option. From 0f32136de89a8676bb21ca505245357182a480b4 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 19 Feb 2024 14:57:41 +0100 Subject: [PATCH 15/19] add info about ssl setup --- tutorials/dockerized-versions.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index c90171377..6c3a10772 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -42,7 +42,10 @@ docker exec -it panel php artisan p:user:make ### Environment Variables There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option. -::: warning If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so certificates can be generated. ::: +::: warning SSL Setup +If you want to use ssl for your panel you need to provide a `LE_EMAIL`. This will enable the ssl webserver config and automatically generate a Let's Encrypt certificate. +You can also put custom certs in `/srv/pterodactyl/certs/`. +::: | Variable | Description | Required | | -------------------- | ------------------------------------------------------------------------------ | -------- | From 1c0b7c4fd53a9845cc0570291e4f4969b3a540c4 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 19 Feb 2024 15:06:08 +0100 Subject: [PATCH 16/19] small updates --- tutorials/dockerized-versions.md | 72 ++++++++++++++++---------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index 6c3a10772..67f69d552 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -12,30 +12,30 @@ For a quick start you can run `curl -sSL https://get.docker.com/ | CHANNEL=stabl ### Requirements The docker image requires some additional software to function. The software can either be provided in other containers (see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) as an example) or as existing instances. -A mysql database is required. We recommend the stock [MariaDB Image](https://hub.docker.com/_/mariadb/) image if you prefer to run it in a docker container. As a non-containerized option we recommend mariadb. +A mysql database is required. We recommend the stock [MariaDB Image](https://hub.docker.com/_/mariadb/) if you prefer to run it in a docker container. As a non-containerized option we recommend mariadb. -A caching software is required as well. We recommend the stock [Redis Image](https://hub.docker.com/_/redis/) image. You can choose any of the [supported options](#cache-drivers). +A caching software is required as well. We recommend the stock [Redis Image](https://hub.docker.com/_/redis/). You can choose any of the [supported options](#cache-drivers). You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file. -If using the docker-compose file the location of a custom `.env` file would be `/srv/pterodactyl/var/.env`. +If using the example docker-compose file the location of a custom `.env` file would be `/srv/pterodactyl/var/.env`. ### Setup Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). ```bash -# If you are using docker compose +# With docker compose: curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/panel/1.0-develop/docker-compose.example.yml docker-compose up -d -# If you are running the docker container without docker compose +# Docker container without compose: docker create -it --name panel ghcr.io/pterodactyl/panel ``` After the startup is complete you'll need to create a panel user. ```bash -# If you are using docker compose +# With docker compose: docker-compose exec panel php artisan p:user:make -# If you are running the docker container without docker compose +# Docker container without compose: docker exec -it panel php artisan p:user:make ``` @@ -43,36 +43,36 @@ docker exec -it panel php artisan p:user:make There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option. ::: warning SSL Setup -If you want to use ssl for your panel you need to provide a `LE_EMAIL`. This will enable the ssl webserver config and automatically generate a Let's Encrypt certificate. +If you want to use SSL for your panel you need to provide a `LE_EMAIL`. This will enable the SSL webserver config and automatically generate a Let's Encrypt certificate. You can also put custom certs in `/srv/pterodactyl/certs/`. ::: -| Variable | Description | Required | -| -------------------- | ------------------------------------------------------------------------------ | -------- | -| `APP_URL` | The URL the panel will be reachable with (including protocol) | yes | -| `APP_TIMEZONE` | The [timezone](http://php.net/manual/en/timezones.php) to use for the panel | yes | -| `LE_EMAIL` | The email used for letsencrypt certificate generation | maybe | -| `DB_HOST` | The host of the mysql instance | yes | -| `DB_PORT` | The port of the mysql instance | yes | -| `DB_DATABASE` | The name of the mysql database | yes | -| `DB_USERNAME` | The mysql user | yes | -| `DB_PASSWORD` | The mysql password for the specified user | yes | -| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes | -| `SESSION_DRIVER` | The session driver (see [Session drivers](#session-drivers) for detais) | yes | -| `QUEUE_DRIVER` | The queue driver (see [Queue drivers](#queue-drivers) for detais) | yes | -| `REDIS_HOST` | The hostname or IP address of the redis database | maybe | -| `REDIS_PORT` | The port the redis database is using on the host | maybe | -| `REDIS_PASSWORD` | The password used to secure the redis database | maybe | -| `MEMCACHED_HOST` | The hostname or IP address of memcached | maybe | -| `MEMCACHED_PORT` | The port of memcached | maybe | -| `MEMCACHED_USERNAME` | The memcached user | maybe | -| `MEMCACHED_PASSWORD` | The memcached password for the specified user | maybe | -| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes | -| `MAIL_FROM` | The email that should be used as the sender email | yes | -| `MAIL_HOST` | The host of your mail driver instance | maybe | -| `MAIL_PORT` | The port of your mail driver instance | maybe | -| `MAIL_USERNAME` | The username for your mail driver | maybe | -| `MAIL_PASSWORD` | The password for your mail driver | maybe | +| Variable | Description | Required | +| -------------------- | ------------------------------------------------------------------------------------- | -------- | +| `APP_URL` | The URL the panel will be reachable with (including https:// or http:// respectively) | yes | +| `APP_TIMEZONE` | The [timezone](http://php.net/manual/en/timezones.php) to use for the panel | yes | +| `LE_EMAIL` | The email used for letsencrypt certificate generation | maybe | +| `DB_HOST` | The host of the mysql instance | yes | +| `DB_PORT` | The port of the mysql instance | yes | +| `DB_DATABASE` | The name of the mysql database | yes | +| `DB_USERNAME` | The mysql user | yes | +| `DB_PASSWORD` | The mysql password for the specified user | yes | +| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes | +| `SESSION_DRIVER` | The session driver (see [Session drivers](#session-drivers) for detais) | yes | +| `QUEUE_DRIVER` | The queue driver (see [Queue drivers](#queue-drivers) for detais) | yes | +| `REDIS_HOST` | The hostname or IP address of the redis database | maybe | +| `REDIS_PORT` | The port the redis database is using on the host | maybe | +| `REDIS_PASSWORD` | The password used to secure the redis database | maybe | +| `MEMCACHED_HOST` | The hostname or IP address of memcached | maybe | +| `MEMCACHED_PORT` | The port of memcached | maybe | +| `MEMCACHED_USERNAME` | The memcached user | maybe | +| `MEMCACHED_PASSWORD` | The memcached password for the specified user | maybe | +| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes | +| `MAIL_FROM` | The email that should be used as the sender email | yes | +| `MAIL_HOST` | The host of your mail driver instance | maybe | +| `MAIL_PORT` | The port of your mail driver instance | maybe | +| `MAIL_USERNAME` | The username for your mail driver | maybe | +| `MAIL_PASSWORD` | The password for your mail driver | maybe | #### Cache drivers You can choose between different cache drivers depending on what you prefer. @@ -129,11 +129,11 @@ The docker image doesn't require any additional software to function. See the [d ### Setup Start the docker container. ```bash -# If you are using docker compose +# With docker compose: curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wings/develop/docker-compose.example.yml docker-compose up -d -# If you are running the docker container without docker compose +# Docker container without compose: docker create -it --name wings ghcr.io/pterodactyl/wings ``` From ba8043ebe52bd77da04a4add9954dccdaa0de71a Mon Sep 17 00:00:00 2001 From: Boy132 Date: Mon, 19 Feb 2024 15:24:47 +0100 Subject: [PATCH 17/19] add "updating" section and use docker run instead of create --- tutorials/dockerized-versions.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index 67f69d552..67ace46b7 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -27,7 +27,7 @@ curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/pane docker-compose up -d # Docker container without compose: -docker create -it --name panel ghcr.io/pterodactyl/panel +docker run -d -it --name panel ghcr.io/pterodactyl/panel ``` After the startup is complete you'll need to create a panel user. @@ -134,7 +134,7 @@ curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wing docker-compose up -d # Docker container without compose: -docker create -it --name wings ghcr.io/pterodactyl/wings +docker run -d -it --name wings ghcr.io/pterodactyl/wings ``` After the startup is complete you can follow the [normal wings setup guide](/wings/1.0/installing.md#configure) to create a new node. @@ -148,3 +148,30 @@ There are some environment variables to configure wings, see the following table | `WINGS_UID` | The UID of the wings user | yes | | `WINGS_GID` | The GID of the wings user | yes | | `WINGS_USERNAME` | The username of the wings user | yes | + +## Updating +Note: Updating will not affect running gameservers. + +### Panel +```bash +# With docker compose: +docker-compose pull +docker-compose down +docker-compose up -d + +# Docker container without compose: +docker pull ghcr.io/pterodactyl/panel +docker restart panel +``` + +### Wings +```bash +# With docker compose: +docker-compose pull +docker-compose down +docker-compose up -d + +# Docker container without compose: +docker pull ghcr.io/pterodactyl/wings +docker restart wings +``` From f083827bf514b6d2de3f5cb1c82e992f43b27c3c Mon Sep 17 00:00:00 2001 From: Boy132 Date: Tue, 20 Feb 2024 15:22:51 +0100 Subject: [PATCH 18/19] remove "without docker compose" commands --- tutorials/dockerized-versions.md | 37 ++++++-------------------------- 1 file changed, 6 insertions(+), 31 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index 67ace46b7..f26041d63 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -22,21 +22,15 @@ If using the example docker-compose file the location of a custom `.env` file wo ### Setup Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/1.0-develop/docker-compose.example.yml) file as an example). ```bash -# With docker compose: curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/panel/1.0-develop/docker-compose.example.yml -docker-compose up -d -# Docker container without compose: -docker run -d -it --name panel ghcr.io/pterodactyl/panel +# Make sure you fill the environment variables in the compose file first +docker-compose up -d ``` After the startup is complete you'll need to create a panel user. ```bash -# With docker compose: docker-compose exec panel php artisan p:user:make - -# Docker container without compose: -docker exec -it panel php artisan p:user:make ``` ### Environment Variables @@ -129,12 +123,10 @@ The docker image doesn't require any additional software to function. See the [d ### Setup Start the docker container. ```bash -# With docker compose: curl -L -o docker-compose.yml https://raw.githubusercontent.com/pterodactyl/wings/develop/docker-compose.example.yml -docker-compose up -d -# Docker container without compose: -docker run -d -it --name wings ghcr.io/pterodactyl/wings +# If you want to use SSL for wings you need to edit the compose file first and uncomment the let's encrypt volume +docker-compose up -d ``` After the startup is complete you can follow the [normal wings setup guide](/wings/1.0/installing.md#configure) to create a new node. @@ -150,28 +142,11 @@ There are some environment variables to configure wings, see the following table | `WINGS_USERNAME` | The username of the wings user | yes | ## Updating -Note: Updating will not affect running gameservers. +Note: Updating will *not* affect running gameservers. -### Panel +Run the following commands in the directory of your compose file. The steps are the same for the Panel and Wings. ```bash -# With docker compose: docker-compose pull docker-compose down docker-compose up -d - -# Docker container without compose: -docker pull ghcr.io/pterodactyl/panel -docker restart panel -``` - -### Wings -```bash -# With docker compose: -docker-compose pull -docker-compose down -docker-compose up -d - -# Docker container without compose: -docker pull ghcr.io/pterodactyl/wings -docker restart wings ``` From f88540f2acc6e523a739fd8de9736a75b03180e3 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Tue, 20 Feb 2024 15:25:37 +0100 Subject: [PATCH 19/19] move note --- tutorials/dockerized-versions.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tutorials/dockerized-versions.md b/tutorials/dockerized-versions.md index f26041d63..c3cf4e22f 100644 --- a/tutorials/dockerized-versions.md +++ b/tutorials/dockerized-versions.md @@ -142,11 +142,10 @@ There are some environment variables to configure wings, see the following table | `WINGS_USERNAME` | The username of the wings user | yes | ## Updating -Note: Updating will *not* affect running gameservers. - Run the following commands in the directory of your compose file. The steps are the same for the Panel and Wings. ```bash docker-compose pull docker-compose down docker-compose up -d ``` +Note: Updating will *not* affect running gameservers.