Skip to content

bannert1337/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

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

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
Activity

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%