portainer_templates/README.md

166 lines
4.1 KiB
Markdown
Raw Normal View History

2019-02-06 14:00:57 +01:00
2020-09-03 08:58:33 +02:00
# Portainer V2 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
### Portainer V1 Templates for Selfhosted Projects/Homelabs has moved to
url: `https://raw.githubusercontent.com/Qballjos/portainer_templates/master/V1 Template/template.json`
!!!This template will no longer be maintained!!!
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
1. Login to your portainer setup go to settings
2020-06-03 17:12:01 +02:00
2. Enable Use external templates
3. Add the url: `https://raw.githubusercontent.com/Qballjos/portainer_templates/master/Template/template.json` then go to app templates and hit refresh at the top.
2020-06-03 17:12:01 +02:00
### 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
2021-09-19 09:51:19 +02:00
- Adguard
- Airsonic
- Authelia
- Bazarr
- Beets
- Vaultwarden
- Booksonic
- Cops
- Calibre-web
- Chevereto
- Chowdown
- Code-server
- Codiad
- Couchpotato
- Daapd
- Dashmachine
- Davos
- Deemix
- Domoticz
- Duckdns
- Duplicati
- Emby
- EmbyStat
- Filebrowser
- Freshrss
- Gazee
- Guacamole
- Grocy
- Htpcmanager
- Headphones
- Heimdall
- Homer
- Huginn
- Invoice_ninja
- Jackett
2023-12-04 11:34:10 +01:00
- Jellyfin
- Jellyseerr
2021-09-19 09:51:19 +02:00
- kodi-headless
- Lazylibrarian
- Letsencrypt / SWAG
- Librespeed
- Lidarr
- Lychee
- Mariadb
- Mcmyadmin2
- Medusa
- Minetest
- Minisatip
- Mstream
- Murmur
- Musicbrainz
- Muximux
- Mylar
- Nzbget
- Nzbhydra2
- Nextcloud
- Nginx
- Nginx-proxy-manager
- Oscam
- Ombi
- Openvpn-as
- Organizr-v2
- Overseerr
- Owncloud
2023-01-30 16:24:48 +01:00
- Passky Client
- Passky Server
2021-09-19 09:51:19 +02:00
- Petio
- Photoshow
- Pihole
- Piwigo
- Plex
- Plexrequests
- Projectsend
- Protonmail-bridge
- Prowlarr
- Pydio
- Qbittorrent
- Quassel-core
- Radarr
- Reactive-resume
- Resilio-sync
- Rutorrent
- Sabnzbd
- Shiori
- Sickchill
- Sickgear
- Smokeping
- Snibox
- Sonarr
- Syncthing
- Tautulli
- Thelounge
- Tiddlywiki
- Tt-rss
- Transmission
- Transmission-openvpn
- Tvheadend
- Ubooquity
- Unifi-controller
2023-02-06 14:30:02 +01:00
- Uptime Kuma
2021-09-19 09:51:19 +02:00
- Watchtower
- Webgrabplus
- Whoogle
- Wikijs
- Yacht
- Youtubedl-material
- 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-11 14:23:49 +02:00
* **NASHosted** - *Current Work* - [NASHOSTED](https://github.com/nashosted)
* **SelfhostedPro** - *Current Work* - [SelfhostedPro](https://github.com/SelfhostedPro)
2019-02-06 11:03:45 +01:00
* **Jos Visser** - *Initial work* - [Qballjos](https://github.com/Qballjos)
2020-09-03 09:01:13 +02:00
* **xe-nvdk** - *template conversion to portainer V2* - [xe-nvdk](https://github.com/xe-nvdk)
* **tbiering** - *Termplate cleanup and typo fixes* - [tbiering](https://github.com/tbiering)
2019-02-06 11:03:45 +01:00
See also the list of [contributors](https://github.com/Qballjos/portainer_templates/graphs/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
2020-09-03 09:19:20 +02:00
* The team behind Portainer for there awesome product and support in the community