mirror of
https://github.com/parkervcp/eggs.git
synced 2024-11-23 04:52:52 +08:00
Adding how-to
This commit is contained in:
parent
99dd69aec7
commit
d8ba0d795f
41
HOWTO.md
Normal file
41
HOWTO.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# So you want to make an Egg
|
||||||
|
|
||||||
|
## General rules
|
||||||
|
|
||||||
|
1. Keep it simple.
|
||||||
|
We don't need 8 miles of install script
|
||||||
|
2. Keep it Small.
|
||||||
|
Only use what is absolutely needed.
|
||||||
|
3. Try to stay in the stock containers.
|
||||||
|
If you need something in a container PR it to [my container repo](https://github.com/parkervcp/Containers) 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.
|
@ -7,6 +7,11 @@ With that I am also accepting PR's for new service and also updates to the curre
|
|||||||
If you are submitting PR's try and keep names and titles the same.
|
If you are submitting PR's try and keep names and titles the same.
|
||||||
|
|
||||||
|
|
||||||
|
## Please read the HOWTO.md before submitting PRs
|
||||||
|
|
||||||
|
|
||||||
|
#### Please read the HOWTO.md as it container important information.
|
||||||
|
|
||||||
## Current Game Eggs
|
## Current Game Eggs
|
||||||
### GTA
|
### GTA
|
||||||
#### FiveM
|
#### FiveM
|
||||||
|
Loading…
Reference in New Issue
Block a user