mirror of https://github.com/parkervcp/eggs.git synced 2024-11-23 13:13:00 +08:00

William Cody Ardoin 4fcce7cb30

Github monitors the "CONTRIBUTING.md" for the "Community" feature. This falls under that. I feel this would be better listed as that feature instead of a seperate Markdown that Github has no special features for.

2018-03-10 00:56:43 -06:00

1.5 KiB

Raw Blame History

So you want to make an Egg

General rules

Keep it simple.
We don't need 8 miles of install script
Keep it Small.
Only use what is absolutely needed.
Try to stay in the stock containers.
If you need something in a container PR it to my image repo where I can review and pull up to the main repo.

Step 1.

Be aware of the pterodactyl install process.

The Pterodactyl install process is fairly simple once you know.

1. Spin up install container
    This uses a volume mount on /mnt/server for the server files.
    This can pull or set up all that is needed to run the server.
    It is regularly used to just download the files required. Such as server files and configs.
    
2. Stop install container

3. Start a new container with the server files in /home/container
    This is where the server is actually run.
    Any dependencies installed during the install process are gone.
    The container that is started should have everything you need.

Step 2.

Testing

Make sure your install process is rock solid as I will be testing eggs before they ever hit my repo.

I will make sugestions and changes at will.
This is to maintain a clean repo that others can pull and be fully aware of what is being done.

Step 3.

Don't be afraid to submit PR's to the egg repo.

I dont bite. I will work with you on the egg and the required things to run it.

1.5 KiB Raw Blame History