diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 9022019..0000000 Binary files a/.DS_Store and /dev/null differ diff --git a/Images/tiddlywiki.png b/Images/tiddlywiki.png new file mode 100644 index 0000000..f397482 Binary files /dev/null and b/Images/tiddlywiki.png differ diff --git a/README.md b/README.md index 5e6117d..a543daa 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Portainer Templates for Selfhosted Projects/Homelabs -This is a rewriten template that will be working with the latest portainer version +This is a template focused on helping people spin up selfhosted services using Portainer. ### Prerequisites -1. A Server running OMV (Not 100% required but folders will be created in /srv/dev-disk-by-label-media if not installed) -2. The following folders: +1. A Server running OMV with a drive labeled media (Not 100% required but folders will be created in /srv/dev-disk-by-label-media if not installed) +2. The following shared folders: * Files (required) * Downloads * TV @@ -15,22 +15,40 @@ This is a rewriten template that will be working with the latest portainer versi * Books * Comics * Podcasts - * Logs 3. A Portainer setup. +*Want something we don't have? Make an issue and we'll work on adding it* + ### 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 -If you wish to contribute contact me by email. +If you wish to contribute make a pull request, create an issue, or email me. ## Authors - +* **NASHosted** - *Current Work* +* **SelfhostedPro** - *Current Work* * **Jos Visser** - *Initial work* - [Qballjos](https://github.com/Qballjos) -See also the list of [contributors](https://github.com/Qballjos/portainer_templates/contributors) who participated in this project. +See also the list of [contributors](https://github.com/SelfhostedPro/selfhosted_templates/contributors) who participated in this project. ## Acknowledgments diff --git a/Template/template.json b/Template/template.json index cb81706..31083a8 100644 --- a/Template/template.json +++ b/Template/template.json @@ -2,7 +2,7 @@ { "type": 1, "title": "htpcmanager", - "description": "Htpcmanager, a front end for many htpc related applications. Hellowlol version. this is a test", + "description": "Htpcmanager, a front end for many htpc related applications. Hellowlol version.", "logo": "https://raw.githubusercontent.com/SelfhostedPro/selfhosted_templates/master/Images/htpcmanager-icon.png", "image": "linuxserver/htpcmanager:latest", "categories": ["Video", "Music", "Other"], @@ -1322,6 +1322,7 @@ "image": "linuxserver/plex:latest", "categories": ["Video", "Music", "Photos"], "platform": "linux", + "network": "host", "volumes": [{"container": "/config", "bind": "/srv/dev-disk-by-label-media/Files/AppData/Config/Plex" }], @@ -2354,6 +2355,23 @@ } ] }, + { + "type": 1, + "title": "TiddlyWiki", + "description": "A unique, non-linear notebook wiki.", + "logo": "https://raw.githubusercontent.com/SelfhostedPro/selfhosted_templates/master/Images/tiddlywiki.png", + "image": "mazzolino/tiddlywiki:latest", + "categories": ["Other", "Tools"], + "platform": "linux", + "ports": [ + "8080:8080/tcp" + ], + "volumes": [ + {"container": "/var/lib/tiddlywiki", + "bind": "/srv/dev-disk-by-label-media/Files/AppData/Config/TiddlyWiki" + } + ] + }, { "type": 1, "title": "Nginx Proxy Manager",