Skip to content

koop-cc/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

169 Commits
.github
.github
 
 
lib
lib
 
 
sources
sources
 
 
Dockerfile
Dockerfile
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
Schema.json
Schema.json
 
 
index.html
index.html
 
 
sources.csv
sources.csv
 
 
templates.json
templates.json
 
 

Repository files navigation

Portainer Templates

A compiled list of 400+ ready to go Portainer App templates

🌐 portainer-templates.as93.net

TL;DR Under Settings → App Templates in your Portainer GUI, paste this URL:
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Contents

Intro

In Portainer, App Templates enable you to easily deploy services with a predetermined configuration, while allowing you to customize options through the web UI. While Portainer ships with some default templates (see portainer/templates), it's often helpful to have 1-click access to many more apps + stacks, without having to constantly switch template sources.

This repo combines app templates from several sources, to create a ready-to-go template file containing all the apps you'll ever need. It's also possible to self-host, as well as combine with your own custom templates.

You can browse all supported apps and stacks and see stats, config options and stand-alone installation commands for each, at portainer-templates.as93.net

Usage

  1. Log into your Portainer web UI
  2. Under Settings --> App Templates, update the URL to
    • https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
  3. Now under Home --> App Templates, you should see all apps. Click one to deploy.
Show me...

Alternatively, when you start Portainer, you can append the --templates flag pointing to the templates URL.

Self-Hosting

If you'd prefer to source templates locally, you can self-host with Docker - there's a sample NGINX container provided
Just run: docker run -p 8080:80 lissy93/portainer-templates (changing 8080 to a port of your choice)
You'll then be able to pass Portainer the template file located at http://[host]:[port]/templates.json

Alternatively, you can build the image yourself locally, with the following commands (if you're using your own fork, don't forget to switch lissy93 out for your username!)

git clone https://github.com/lissy93/portainer-templates.git
cd portainer-templates
docker build -t portainer-templates .
docker run -d -p "8080:80" portainer-templates

If you're using your own template file, but don't want to fork this repository, you can instead simply pass your templates.json file to the above Docker container as a volume, with -v "${PWD}/templates.json:/usr/share/nginx/html/templates.json"

Editing

The template.json file is generated using the scripts in lib, using GitHub Actions. Running the make command will download all listed sources, parse them, and combine them with anything in the sources dir, outputting the templates.json file.
So, you only need to edit either the sources.csv file, or add your templates directly into the sources/ directory.

Adding a new Source

If you're maintaining your own list of Portainer templates, and would like them to be included, just add the URL to your template.json file to sources.csv, along with a name. When the action runs, it will download the content, parse it and add it to the final template.

Adding a Template / Template list

Alternatively, place your template file within the sources directory, and it will be automatically combined into the main template.json. Be sure that your template corresponds to Portainer's App Template JSON Format.

Validating Templates

There is a schema defined in Schema.json, which can be used to validate any Portainer template. Run make validate to ensure your template conforms to Portainer's App Template specification.

Maintaining your own Templates

If you'd like to use this repo as a base, but maintain your own list of template, just fork the repository, and update lissy93 with your username in the import URL.

Supported Apps and Stacks


↕️ Click to Expand ↕️

Click an item, to see stats, config options and installation instructions

  1. Activepieces
  2. Actual
  3. Adguard
  4. Adguard Home
  5. Adguardhome-Sync
  6. Airsonic
  7. Airsonic-Advanced
  8. Alpine Xfce4 Novnc
  9. Altus
  10. Ansible-Semaphore
  11. Apache Httpd
  12. Apprise-Api
  13. Appsmith
  14. Appwrite
  15. Archisteamfarm
  16. Archivebox
  17. Aria2 Pro
  18. Ariang
  19. Audacity
  20. Audiobookshelf
  21. Authelia
  22. Authentik
  23. Autobrr
  24. Babybuddy
  25. Baikal
  26. Bambustudio
  27. Baserow
  28. Bazarr
  29. Beets
  30. Bitwarden Rs
  31. Blender
  32. Boinc
  33. Booksonic
  34. Booksonic-Air
  35. Bookstack
  36. Broadlink Manager
  37. Budge
  38. Budibase
  39. Build-Agent
  40. Caddy
  41. Calibre
  42. Calibre Web
  43. Calligra
  44. Cardigann
  45. Castopod
  46. Change Detection
  47. Changedetection.Io
  48. Chevereto
  49. Chiefonboarding
  50. Chowdown
  51. Chromium
  52. Chrony Ntp
  53. Ci
  54. Clamav
  55. Cloud Commander
  56. Cloud9
  57. Cloudflare Ddns
  58. Cockroachdb
  59. Code Server
  60. Codex
  61. Codiad
  62. Commandbox
  63. Contentbox
  64. Cops
  65. Couchpotato
  66. Cratedb
  67. Cryptofolio
  68. Cura
  69. Daapd
  70. Darktable
  71. Dashdot
  72. Dashmachine
  73. Dashy
  74. Datadog Agent
  75. Davinci Postgres Server
  76. Davos
  77. Ddclient
  78. Deemix
  79. Deluge
  80. Deluge Openvpn
  81. Digikam
  82. Dillinger
  83. Diskover
  84. Docker Container Stats
  85. Dockge
  86. Documize
  87. Dokemon
  88. Dokku
  89. Dokuwiki
  90. Domoticz
  91. Doplarr
  92. Doublecommander
  93. Dozzle
  94. Dradis
  95. Draw.Io
  96. Droppy
  97. Drupal
  98. Duck Dns
  99. Duplicacy
  100. Duplicati
  101. Eclipse Mosquitto Mqtt
  102. Edgeconnector 840D
  103. Edgeconnector Aggregator
  104. Edgeconnector Fanuc Cnc
  105. Edgeconnector Modbus
  106. Edgeconnector Siemens
  107. Elasticsearch
  108. Emby
  109. Embystat
  110. Emulatorjs
  111. Endlessh
  112. Eufy Security Ws
  113. Excalidraw
  114. Fail2Ban
  115. Faster-Whisper
  116. Fdo
  117. Feed2Toot
  118. Feedcord
  119. Fenrus
  120. Ferdi Server
  121. Ferdium
  122. Fetchcord
  123. Ffmpeg
  124. Filebrowser
  125. Filebrowser Latest
  126. Filebrowser S6
  127. Filepizza
  128. Filerun
  129. Filestash
  130. Filezilla
  131. Firefox
  132. Fireshare
  133. Flame
  134. Flame-Dashboard
  135. Flaresolverr
  136. Fleet
  137. Flexget
  138. Floating License Server
  139. Flood
  140. Flowiseai
  141. Foldingathome
  142. Foundryvtt Server
  143. Freeboard
  144. Freecad
  145. Freescout
  146. Freshrss
  147. Frigate Nvr
  148. Funkwhale
  149. Gaps
  150. Gazee
  151. Ghost
  152. Ghostfolio
  153. Gimp
  154. Gitea
  155. Github-Desktop
  156. Gitlab Ce
  157. Gitqlient
  158. Glances
  159. Go-Socks5-Proxy
  160. Gokapi
  161. Gotify
  162. Grafana
  163. Grav
  164. Grocy
  165. Guacamole
  166. Habridge
  167. Hasty-Paste
  168. Hauk
  169. Headphones
  170. Healthchecks
  171. Hedgedoc
  172. Heimdall
  173. Hishtory-Server
  174. Homarr
  175. Homarr-Secured
  176. Homeassistant
  177. Homebridge
  178. Homebridge - Debian
  179. Homechart
  180. Homepage
  181. Homer
  182. Htpc Manager
  183. Httpd
  184. Huginn
  185. Hydra2
  186. I Hate Money
  187. Immich
  188. Influxdb
  189. Influxdb & Telegraf
  190. Influxdb 1.8.10
  191. Inkscape
  192. Invoice Ninja
  193. Iobroker
  194. Iperf
  195. Ironfunctions
  196. Ironfunctions Api
  197. Ironfunctions Ui
  198. Jackett
  199. Jdownloader
  200. Jellyfin
  201. Jellyfin-Accounts
  202. Jellyseer
  203. Jellyseerr
  204. Jenkins
  205. Jenkins-Builder
  206. Joomla
  207. Joplin
  208. Jump
  209. Kanzi
  210. Kapowarr
  211. Kasm
  212. Kavita
  213. Kdenlive
  214. Kicad
  215. Kimai
  216. Kiwix
  217. Klaxon
  218. Klipper[Testing], Mainsail, Moonraker
  219. Kodi Headless
  220. Koillection
  221. Komga
  222. Krita
  223. Lazylibrarian
  224. Lazytainer
  225. Ldap-Auth
  226. Leantime
  227. Let'S Encrypt / Swag
  228. Letsencrypt
  229. Libreddit
  230. Libreoffice
  231. Libresonic
  232. Librespeed
  233. Lidarr
  234. Limnoria
  235. Linkstack
  236. Littlelink Server
  237. Liveswitch
  238. Lldap
  239. Logzio Logs Collector
  240. Logzio Metrics Collector
  241. Lollypop
  242. Lychee
  243. Magento 2
  244. Magicmirror2
  245. Mailpile
  246. Maloja
  247. Mariadb
  248. Mastodon
  249. Matomo
  250. Mautic
  251. Mayan Edms
  252. Mcmyadmin 2
  253. Mealie
  254. Mediaelch
  255. Medusa
  256. Meilisearch
  257. Meshcentral
  258. Metube
  259. Microsoft Oms Agent
  260. Midarr
  261. Minecraft Server
  262. Minetest
  263. Miniflux
  264. Minio
  265. Minisatip
  266. Mongo
  267. Monica
  268. Moodle
  269. Mozilla Syncserver
  270. Mstream
  271. Mullvad-Browser
  272. Murmur
  273. Musicbrainz
  274. Muximux
  275. Mylar
  276. Mylar3
  277. Mysql
  278. Mysql-Workbench
  279. N8N
  280. Nano
  281. Nano-Wallet
  282. Navidrome
  283. Neko
  284. Netboot.Xyz
  285. Netbox
  286. Netdata
  287. Nextcloud
  288. Nextcloudstack
  289. Nginx
  290. Nginx Proxy Manager
  291. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  292. Nginx Proxy Manager V2 With Sqllite
  293. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  294. Ngircd
  295. Nitter
  296. Nocodb
  297. Nodejs
  298. Nodered
  299. Nord-Vpn
  300. Nut Server
  301. Nuts
  302. Nzbget
  303. Nzbhydra 2
  304. Octoprint
  305. Odoo
  306. Omada Eap Controller
  307. Ombi
  308. Opc Router
  309. Openamt
  310. Openbudgeteer
  311. Openfaas
  312. Openssh-Server
  313. Openvpn Access Server
  314. Openvpn-As
  315. Openvscode-Server
  316. Opera
  317. Orcaslicer
  318. Organizr
  319. Organizr V2
  320. Ory Kratos (Oathkeeper)
  321. Ory Kratos (Standalone)
  322. Oscam
  323. Outline
  324. Overseerr
  325. Owncloud
  326. Pairdrop
  327. Paperless Ngx
  328. Paperless-Ng
  329. Papermerge
  330. Passbolt
  331. Passky Client
  332. Passky Server
  333. Petio
  334. Pgadmin
  335. Photoprism
  336. Photoshow
  337. Phpmyadmin
  338. Pi-Hole
  339. Pi-Hole Doh/Dot
  340. Pi-Hole-Unbound
  341. Pi.Alert
  342. Pidgin
  343. Pingvin Share
  344. Piper
  345. Piwigo
  346. Pixapop
  347. Pixel-Server
  348. Plane
  349. Plesk
  350. Plex
  351. Plex Media Server
  352. Plex Requests
  353. Plex-Meta-Manager
  354. Plextraktsync
  355. Plone
  356. Portainer Agent
  357. Poste.Io
  358. Postgresql
  359. Pritunl
  360. Privatebin
  361. Pro Mosquitto With Management Center
  362. Projectsend
  363. Protonmail Bridge
  364. Prowlarr
  365. Proxitok
  366. Pure-Ftp Server
  367. Pve-Exporter
  368. Pwndrop
  369. Pydio
  370. Pydio-Cells
  371. Pyload-Ng
  372. Pylon
  373. Qbittorrent
  374. Qdirstat
  375. Qflood
  376. Quassel Irc
  377. Quassel-Core
  378. Quassel-Web
  379. Rabbitmq
  380. Radarr
  381. Raneto
  382. Raspberry Pi Docker Monitor
  383. Rclone Config Backup
  384. Rdesktop
  385. Reactive-Resume
  386. Readarr
  387. Readme-Sync
  388. Redis
  389. Redis Cluster
  390. Redmine
  391. Registry
  392. Registry (Cache)
  393. Remmina
  394. Remotely
  395. Requestrr
  396. Resilio Sync
  397. Reveal.Js
  398. Rocket Chat
  399. Rport
  400. Rsnapshot
  401. Rust Desk
  402. Rutorrent
  403. Sabnzbd
  404. Samba
  405. Scality S3
  406. Scrutiny
  407. Searxng
  408. Sematext Docker Agent
  409. Series-Troxide
  410. Servas
  411. Shaarli
  412. Shiori
  413. Sickchill
  414. Sickgear
  415. Sickrage
  416. Signal Proxy
  417. Silverstripe
  418. Smokeping
  419. Snapdrop
  420. Snibox
  421. Snipe-It
  422. Snippet Box
  423. Softing Edgeconnector 840D
  424. Softing Edgeconnector Aggregator
  425. Softing Edgeconnector Fanuc Cnc
  426. Softing Edgeconnector Modbus
  427. Softing Edgeconnector Siemens
  428. Solr
  429. Sonarr
  430. Speedtest Tracker
  431. Sql Server
  432. Sql Server Express
  433. Sqlitebrowser
  434. Sshwifty
  435. Stash
  436. Statping
  437. Steamos
  438. Surrealdb
  439. Swag
  440. Swarm Monitoring
  441. Synclounge
  442. Syncthing
  443. Syslog-Ng
  444. System Stats Oled Display
  445. Tabby
  446. Tailscale
  447. Tandoor
  448. Tautulli
  449. Tdarr
  450. Teleport
  451. Tester
  452. Thelounge
  453. Tiddlywiki
  454. Tiny Tiny Rss
  455. Tooljet
  456. Tosibox Lock For Container
  457. Traefik
  458. Traggo
  459. Transmission
  460. Transmission Openvpn Latest
  461. Transmission Openvpn V3
  462. Transmission-Openvpn
  463. Trilium
  464. Trudesk
  465. Tubearchivist
  466. Tvheadend
  467. Twitch Points Miner
  468. Ubooquity
  469. Ubuntu
  470. Umami.Is
  471. Unifi Controller
  472. Unifi Video
  473. Unifi-Network-Application
  474. Unmanic
  475. Unrar
  476. Upsnap
  477. Uptime Kuma
  478. Urbackup
  479. Urlwatch
  480. Vaultwarden
  481. Vikunja
  482. Vlmcsd - Kms
  483. Vscodium
  484. Vsftpd Ftp Server
  485. Wallabag
  486. Watchtower
  487. Webcord
  488. Webgrab+Plus
  489. Webtop
  490. Webtrees
  491. Wger
  492. Whisparr
  493. Whoogle
  494. Wikijs
  495. Wireguard
  496. Wireguard Server
  497. Wireshark
  498. Wizarr
  499. Wordpress
  500. Wowza
  501. Wps-Office
  502. Xbackbone
  503. Xwiki
  504. Yacht
  505. Your_Spotify
  506. Youtubedl-Material
  507. Yq
  508. Znc
  509. Zus.Am

Sources


↕️ Click to Expand ↕️

Full credit to the authors of the following templates. The main templates.json file is composes of these sources, along with the content of the sources directory.

  1. template by @dnburgess
  2. template by @Qballjos
  3. template by @SelfhostedPro
  4. template by @technorabilia
  5. template by @mikestraney
  6. template by @xneo1
  7. template by @novaspirit
  8. template by @donpablonow
  9. template by @mediadepot
  10. template by @mycroftwilde
  11. template by @mediadepot
  12. template by @portainer

Contributing

Contributions of any kind are very welcome, and would be much appreciated. For Code of Conduct, see Contributor Convent.

For a guide on adding templates, see the Editing section above (TLDR; either update sources.csv, or paste your template collection into the ./sources directory). Or, to make changes to the website, see the Website section below.

If you're new to GitHub, you can get started by forking the repo, making your changes, adding, commiting and pushing the code, then come back here to open a pull request. You may also find this guide or the git docs helpful for getting started, but feel free to reach out if you need any support.

Website

There's a simple website, which lists all available templates and shows stats, config options and installation instructions for each app / stack. You can view it at portainer-templates.netlify.app

The source is located in the website branch, and it's build as a simple SSR Svelte app (using SvelteKit + TypeScript + SCSS + Vite). To make changes to the website, you'll need Node.js and Git installed. Then just run the following commands:

git clone -b website [email protected]:Lissy93/portainer-templates.git # Clone the website branch
cd portainer-templates # Navigate into the directory
npm i # Install dependencies
npm run dev # Start the development server

And to pubish, run npm run build then either use npm start or host the content of the '/build' directory using a web server of your choice. Alternatively, there's a Dockerfile, for easy deployment :)

Note that it's not required to make any changes to the website when adding a new template or templates source, as data is fetched directly from templates.json in the repo's main branch - so should show up automatically once your changes are merged.

Mirror

There's a mirror of this repository, maintained on CodeBerg at: codeberg.org/alicia/portainer-templates

To pull templates from there, instead of GitHub, use this URL in your Portainer instance instead:

https://codeberg.org/alicia/portainer-templates/raw/branch/main/templates.json

Credits

Contributors

liss-bot
Alicia Bot 		Lissy93
Alicia Sykes 		Benoniy
Benjamin Ranson 		tempusthales
Gilbert Palau 		kr40
Kartik Rao 		leetrout
Lee Trout
balzack
Pierre Balzack

Sponsors

koconder
Vincent Koc 		peng1can
Peng1can 		tbjers
Torgny Bjers 		emlazzarin
Eddy Lazzarin 		AnandChowdhary
Anand Chowdhary 		shrippen
Shrippen
davidpaulyoung
David Young 		bile0026
Zach Biles 		UlisesGascon
Ulises Gascón 		digitalarche
Digital Archeology 		bmcgonag
Brian McGonagill 		vlad-timofeev
Vlad Timofeev
helixzz
HeliXZz 		forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023) 		Bastii717
Bastii717 		ratty222
Brent 		CrazyWolf13
Tobias 		CrossPatch9000
CrossPatch9000

License

Note For licenses for each app listed here, see their websites (linked to above).

Lissy93/Portainer-Templates is licensed under MIT © Alicia Sykes 2023.
For information, see TLDR Legal > MIT

Expand License 
The MIT License (MIT)
Copyright (c) Alicia Sykes <[email protected]> 

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included install 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© Alicia Sykes 2023
Licensed under MIT

Thanks for visiting :)

About

🚢 500+ 1-click Portainer app templates

portainer-templates.as93.net

Resources

Readme

License

MIT license

Code of conduct

Code of conduct
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 75.2%
  • HTML 18.7%
  • Makefile 4.4%
  • Dockerfile 1.7%