portainer_templates/README.md

140 lines
3.0 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
2020-06-03 17:49:29 +02:00
*for the OMV5 version use the OMV5 branch*
2019-02-06 11:03:45 +01:00
### Prerequisites
2020-06-03 17:49:29 +02:00
1. A server/NAS with docker installed
2. A Portainer setup.
2019-02-06 11:03:45 +01:00
2020-06-03 17:16:28 +02:00
*Want something we don't have? Make an issue and we'll work on adding it*
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
2020-06-03 17:49:29 +02:00
All templates are already configured to bind mount to various places on your drive. This branch works without the need for OMV. The following folders are all created in /portainer/
2020-06-03 17:12:01 +02:00
* **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.
2020-06-08 17:06:25 +02:00
## App List
- Guacamole
- Homer
2020-06-09 16:12:16 +02:00
- Wikijs
- Bazarr
2020-06-08 17:06:25 +02:00
- Jellyfin
- Bitwarden_rs
- Pi-Hole
- Whoogle
- Mstream
- Filebrowser
- YouTubeDL-Material
- DashMachine
- Reactive-Resume
- LibreSpeed
- DeeMix
- Nginx Proxy Manager
- Organizrv2
- TiddlyWiki
- Watchtower
- transmission-openvpn
- airsonic
- beets
- booksonic
- bookstack
- calibre-web
- cardigann
- Chevereto
- codiad
- cops
- couchpotato
- daapd
- davos
- deluge
- domoticz
- duckdns
- duplicati
- freshrss
- gazee
- headphones
- heimdall
- htpcmanager
- jackett
- kodi-headless
- lazylibrarian
- letsencrypt
- libresonic
- lidarr
- lychee
- mariadb
- mcmyadmin
- medusa
- minetest
- minisatip
- musicbrainz
- muximux
- mylar
- nextcloud
- nginx
- nzbget
- nzbhydra
- ombi
- openvpn-as
- oscam
- photoshow
- piwigo
- plex
- plexrequests
- projectsend
- pydio
- qbittorrent
- quassel-core
- radarr
- resilio-sync
- rutorrent
- sabnzbd
- sickrage
- smokeping
- sonarr
- syncthing
- tautulli
- thelounge
- transmission
- tt-rss
- tvheadend
- ubooquity
- unifi
- webgrabplus
- znc
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
2020-06-03 18:55:35 +02:00
* Inspiration being too lazy to create each container template manualy