Skip to content

Quick Start

Jump to bottom
ccarney16 edited this page Jul 24, 2022 · 19 revisions

WARNING! Before you start, it is recommended that you have a good understanding of Pterodactyl and Docker. This quick start will be going through with using docker-compose.

Requirements

This project will require the following commands/packages to work correctly:

  • docker-compose - Can come from Ubuntu/Debian repos, or Docker CE repos if using EL based distros.

Downloading Project from Git

While git is not required to download, it does make it easier to download and stay up to date.

mkdir /srv/app;
cd /srv/app;
git clone https://github.com/ccarney16/pterodactyl-docker pterodactyl;

Create the Project

This project comes with a deployment script, bin/deploy. This script allows a user to select from a few predefined configurations and profiles needed to run Pterodactyl. Running this script as-is will setup the default deployment, suitable for running the panel and daemon on the same machine. The following options are listed below:

Config Options:

  • default - This is the default configuration, provides what is required for the panel and daemon to operate, and comes with certbot to provide SSL options.
  • build - Same as default, but has build parameters for the panel and daemon. This should only be used when building and testing containers.
  • daemon - Only provides the daemon and certbot services. This should be used on machines that will connect to an already established panel and need certbot to work.
  • minimal - This config strips services down to the bare essentials. Services like certbot are not needed here. Ports and certain volumes have also been removed. This option is provided for more advanced setups like reverse proxies.

Available configurations can be viewed by passing --available-configs to the deployment script, and applying them with --config.

Profile Options:

  • daemon - enables the daemon service.
  • letsencrypt - enables certbot service.
  • panel - enables panel and dependencies.

Profiles are a new feature in docker-compose, and is required to upgrade to the latest v2 version. Available profiles can be viewed by passing --available-profiles. Not all configurations support every profile listed here, using --config with --available-profiles will show what profiles the config supports.

Configuring

Options and configuration files can be found in conf.d. panel.env and mariadb.env provide the ability to edit the environment for each respective service. Most of the configuration for the panel is ready out of the box, but check the options to make sure they are suitable for your deployment needs.

Daemon configuration generated by the panel can be copied to conf.d/daemon/config.yml

Starting

For the first startup, just run this command: docker-compose up -d.

This command may take some time as it checks to make sure the panel is healthy before starting the workers. You will be warned if the container failed to properly startup

To create a user for pterodactyl, you can issue this command: bin/artisan p:user:make

To setup the daemon, make the daemon configuration within the web panel, copy the configuration to conf.d/daemon/config.yml. The daemon container should be able to detect the configuration and start wings.

Clone this wiki locally