Skip to content

Commit

Permalink
small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@Boy132
Boy132 authored Feb 19, 2024
1 parent 0f32136 commit 1c0b7c4
Showing 1 changed file with 36 additions and 36 deletions.
72 changes: 36 additions & 36 deletions tutorials/dockerized-versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,67 +12,67 @@ 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
```

### 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 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.
Expand Down Expand Up @@ -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
```

Expand Down

0 comments on commit 1c0b7c4

Please sign in to comment.