portainer_templates/README.md

55 lines
2.1 KiB
Markdown
Raw Normal View History

2019-02-06 14:00:57 +01:00
2020-06-02 23:48:04 +02:00
# Portainer Templates for Selfhosted Projects/Homelabs
2019-02-06 11:03:45 +01:00
2020-06-03 16:43:15 +02:00
This is a template focused on helping people spin up selfhosted services using Portainer.
2019-02-06 11:03:45 +01:00
### Prerequisites
2020-06-03 01:26:10 +02:00
1. A Server running OMV (Not 100% required but folders will be created in /srv/dev-disk-by-label-media if not installed)
2020-06-02 23:48:04 +02:00
2. The following folders:
* Files (required)
* Downloads
* TV
* Movies
* Music
* Books
* Comics
* Podcasts
3. A Portainer setup.
2019-02-06 11:03:45 +01:00
### Installing
2020-06-03 17:12:01 +02:00
1. Login to your portainer setup go to settings
2. Enable Use external templates
3. Add the url: `https://raw.githubusercontent.com/SelfhostedPro/selfhosted_templates/master/Template/template.json` then go to app templates and hit refresh at the top.
### Information
All templates are already configured to bind mount to various places on your drive. The initial build is for use with OpenMediaVault v5. The following folders are all created in /srv/dev-disk-by-label-media/
* **Files** - General file storage.
* **AppData** - Subfolder where application data (unrelated to served data) is stored.
* **Config** - Subfolder where configuration files for every container are stored.
* **Downloads** - Where bittorrent and usenet downloaders download files to.
* **TV** - Where tv shows are stored/moved to after downloaded.
* **Movies** - Where movies are stored/moved to after downloaded.
* **Music** - Where music is stored/moved to after downloaded.
* **Books** - Where books are stored/moved to after downloaded.
* **Comics** - Where comics are stored/moved to after downloaded.
* **Podcasts** - Where podcasts are stored/moved to after downloaded.
2019-02-06 11:03:45 +01:00
## Contributing
2020-06-03 16:43:15 +02:00
If you wish to contribute make a pull request, create an issue, or email me.
2019-02-06 11:03:45 +01:00
## Authors
2020-06-03 16:43:15 +02:00
* **NASHosted** - *Current Work*
* **SelfhostedPro** - *Current Work*
2019-02-06 11:03:45 +01:00
* **Jos Visser** - *Initial work* - [Qballjos](https://github.com/Qballjos)
2020-06-03 16:43:15 +02:00
See also the list of [contributors](https://github.com/SelfhostedPro/selfhosted_templates/contributors) who participated in this project.
2019-02-06 11:03:45 +01:00
## Acknowledgments
* LinuxServer.io for the old Template
* Inspiration being to lazy to create each container template manualy