Custom Containers - n05urpr1532-MHA-Team/PTS-Team GitHub Wiki
Table of Contents
1. Intro
Adding your custom containers to PlexGuide is very simple to do. There is no need for nonsense managed labels pluckered throughout the code. Your generated containers will show up in PTS Vault, PTS Box, and can take advantage of PTS Cron.
2. PTS YouTube - Custom Containers
3. Basic Setup Instructions
Within terminal, type cd /opt/mycontainers.
The easiest way to add your own container is by using the template placed within the folder. To view the template, type ls /opt/mycontainers.
Copy the template within by typing: cp /opt/mycontainers/_template.yml app.yml
Note that app.yml can be called anything; it just needs to end with the .yml extension. For the rest of this guide, we will call it app.yml for simplicity. Below, you will see that the file is generated. From here, type nano /opt/mycontainers/app.yml
Now that your custom container is set, it will show up in PTSbox!
4. Editing Instructions
Editing the file is easy to do. The first part is to establish the containers, role name, the internal and external ports under PART A. Ensure that the ports are not occupied or taken up by another program.
Leave PART B alone. This portion ensures that common variables are executed to ensure that your custom container deploys!
PART C is what enables PTS AppGuard. This may change in the future, but if you want your container exempt, remove this first line.
PART D is what enables your domains and subdomains for your programs. I would recommend that you not utilize this.
PART E is where you would normally configure your data paths. You should follow the guides of the container that you're trying to configure. path.stdout is reserved for where data is being processed; such as a second drive. If did does not matter to you, you can omit and turn it into /mnt or whatever you choose.
PART F is where you set your environmental variables. Unless you're required to add more, it's recommended to leave it alone.
PART G is the key piece required to execute the container. Normally, you shouldn't have to modify this. If you need to, please do.
FINAL NOTE If you're curious, visit the containers portion of the plexguide code and view how the other containers are written up. This will provide you insight into how to execute your custom container!
5. Summary
Adding custom containers via PlexGuide is easy to do. Just follow the template provided and/or watch the PTS YouTube Video and you'll have your custom containers running in a snap!