pterodactyl / development

Development environment setup for Pterodactyl. This is used internally by our development team to ensure getting Pterodactyl running in a development environment is a painless as possible.

Pterodactyl Development Environment

This repository provides a docker-compose based environment for handling local development of Pterodactyl.

This is not meant for production use! This is a local development environment only.

This environment is the official Pterodactyl development environment, in the sense that it is what I, @DaneEveritt use for working on it. I've not tested it on anything other than macOS, and I probably haven't documented most of the important bits. Please feel free to open PRs or Issues as necessary to improve this environment.

Getting Started

You'll need the following things installed on your machine.

• Docker
• Mutagen Compose
• mkcert

Setup

To begin clone this repository to your system, and then run ./setup.sh which will configure the additional git repositories, and setup your local certificates and host file routing.

git clone https://github.com/pterodactyl/development.git
cd development
./setup.sh

What is Created

• Traefik Container
• Panel & Wings Containers
• MySQL & Redis Containers
• Minio Container for S3 emulation

Accessing the Environment

Once you've setup the environment, simply run ./beak up -d to start the environment. This simply aliases some common Docker compose commands.

Once the environment is running, ./beak app and ./beak wings will allow SSH access to the Panel and Wings environments respectively. Your Panel is accessible at https://pterodactyl.test. You'll need to run through the normal setup process for the Panel if you do not have a database and environment setup already. This can be done by SSH'ing into the Panel environment and running setup-pterodactyl.

The code for the setup can be found in build/panel/setup-pterodactyl. Please note, this environment uses Mutagen for file handling, so replace calls to docker compse up or down with mutagen-compose up or down. All other docker compose commands can be used as normal.

development's Issues

App service not running

Hey, i installed dev env for ptero and just ran
./beak up -d

But when i want to
./beak app
i get this error
service "app" is not running container #1

Update package.json

Could somebody update the package.json file because its throwing errors... (Pterodactyl panel)

Go version too old for build wings

When trying to build wings, i have the following error:

root@fc6e4a1edded:/home/root/wings# go run 
go: no go files listed
root@fc6e4a1edded:/home/root/wings# go build
go: downloading github.com/apex/log v1.9.0
go: downloading github.com/twitchyliquid64/golang-asm v0.15.1
go: downloading github.com/chenzhuoyu/iasm v0.9.1
go: downloading golang.org/x/mod v0.16.0
github.com/pterodactyl/wings imports
        github.com/pterodactyl/wings/cmd imports
        github.com/pterodactyl/wings/router imports
        github.com/pterodactyl/wings/server/filesystem imports
        slices: package slices is not in GOROOT (/usr/local/go/src/slices)
go: warning: modernc.org/[email protected]: retracted by module author: tagged accidentally w/o builders checking the commit
go: to switch to the latest unretracted version, run:
        go get modernc.org/sqlite@latest

(i shorted output by removing other line where go successfully get a package)

Error can be solve by upgrade go version in Dockerfile

Vagrant fails to start with a generic message

I am having the following issue when trying to setup this dev environment.
After running vagrant up or vagrant up --provision-with setup app I get the following output:

Bringing machine 'app' up with 'virtualbox' provider...
There are errors in the configuration of this machine. Please fix
the following errors and try again:

vm:
* A box must be specified.

I talked with a few other people from the Ptero discord who have faced a similar issue and none of them have managed to fix it. It looks like what we all have in common is that we are using Linux and this has probably never been tested on it?

Do you have any ideas on how I can fix it and is anyone even using this setup nowadays? Would I be better off by just writing a docker-compose file and DIY-ing the dev setup? What are you guys using?

404 php not found

NodeJS version out of date in Dockerfile

During the setup of the development environment. There is an error that occurs when you run setup-pterodactyl, output here:

yarn install v1.22.19
[1/5] Validating package.json...
error @pterodactyl/panel@: The engine "node" is incompatible with this module. Expected version ">=16.0". Got "14.20.1"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
Restarting periodic command scheduler: cronStopping periodic command scheduler: cron.
Starting periodic command scheduler: cron.

This should be fixed by updating the NodeJS version to 16.X or higher.