{"id":18759897,"url":"https://github.com/pterodactyl/development","last_synced_at":"2025-04-13T02:33:09.760Z","repository":{"id":40325045,"uuid":"139528554","full_name":"pterodactyl/development","owner":"pterodactyl","description":"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.","archived":false,"fork":false,"pushed_at":"2024-03-18T09:32:06.000Z","size":114,"stargazers_count":35,"open_issues_count":7,"forks_count":33,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-05T15:57:53.796Z","etag":null,"topics":["development","docker","docker-compose","pterodactyl"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pterodactyl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-07-03T04:27:40.000Z","updated_at":"2025-03-19T20:45:51.000Z","dependencies_parsed_at":"2024-01-29T16:57:35.306Z","dependency_job_id":"27f7054a-19e9-40c1-a11a-840b7bd45708","html_url":"https://github.com/pterodactyl/development","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterodactyl%2Fdevelopment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterodactyl%2Fdevelopment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterodactyl%2Fdevelopment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterodactyl%2Fdevelopment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pterodactyl","download_url":"https://codeload.github.com/pterodactyl/development/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248657831,"owners_count":21140842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["development","docker","docker-compose","pterodactyl"],"created_at":"2024-11-07T18:08:20.847Z","updated_at":"2025-04-13T02:33:09.511Z","avatar_url":"https://github.com/pterodactyl.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pterodactyl Development Environment\nThis repository provides a `docker-compose` based environment for handling local development of Pterodactyl.\n\n**This is not meant for production use! This is a local development environment only.**\n\n\u003e This environment is the official Pterodactyl development environment, in the sense that it is what\nI, [`@DaneEveritt`](https://github.com/DaneEveritt) use for working on it. I've not tested it on anything\nother than macOS, and I probably haven't documented most of the important bits. Please feel free to open\nPRs or Issues as necessary to improve this environment.\n\n### Getting Started\nYou'll need the following things installed on your machine.\n\n* [Docker](https://docker.io)\n* [Mutagen Compose](https://github.com/mutagen-io/mutagen-compose)\n* [mkcert](https://github.com/FiloSottile/mkcert)\n\n### Setup\nTo begin clone this repository to your system, and then run `./setup.sh` which will configure the\nadditional git repositories, and setup your local certificates and host file routing.\n\n```sh\ngit clone https://github.com/pterodactyl/development.git\ncd development\n./setup.sh\n```\n\n#### What is Created\n* Traefik Container\n* Panel \u0026 Wings Containers\n* MySQL \u0026 Redis Containers\n* Minio Container for S3 emulation\n\n### Accessing the Environment\nOnce you've setup the environment, simply run `./beak up -d` to start the environment. This simply aliases\nsome common Docker compose commands.\n\nOnce the environment is running, `./beak app` and `./beak wings` will allow SSH access to the Panel and\nWings environments respectively. Your Panel is accessible at `https://pterodactyl.test`. You'll need to\nrun through the normal setup process for the Panel if you do not have a database and environment setup\nalready. This can be done by SSH'ing into the Panel environment and running `setup-pterodactyl`.\n\nThe code for the setup can be found in `build/panel/setup-pterodactyl`. Please note, this environment uses\nMutagen for file handling, so replace calls to `docker compse up` or `down` with `mutagen-compose up` or `down`.\nAll other `docker compose` commands can be used as normal.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpterodactyl%2Fdevelopment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpterodactyl%2Fdevelopment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpterodactyl%2Fdevelopment/lists"}