diff --git a/README.md b/README.md index ac21eea..9f8f7f1 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,23 @@ This is a template focused on helping people spin up selfhosted services using P ### Installing -Login to your portainer setup go to settings -> enable Use external templates -> add the url: https://raw.githubusercontent.com/SelfhostedPro/selfhosted_templates/master/Template/template.json +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. ## Contributing