Skip to content

dennislwm/portainer-templates

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Portainer Templates

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

Raising Issues

If you notice something not working as it should in any of the lib/ scripts, website code, README documentation, or workflows automations - then raise an issue or PR in this repository.

If you encounter an issue with any container included here, please raise a ticket/PR on the up-stream repo, not in this repository. This project simply compiles templates listed in the Sources into a single manifest, so once a fix has been pushed out upstream, it will be available here.


Contributing

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

Not a coder? You can still help, by raising bugs you find, updating docs, or consider sponsoring me on GitHub

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.

Before raising an issue or editing a template, please see the Raising Issues section above (TL;DR: changes need to be made upstream, NOT in this repo).

If you're new to open source, I've put together some guides in Git-In, 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 git@github.com: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
shmolf
Nicholas Browning
Benoniy
Benjamin Ranson
tempusthales
Gilbert Palau
kr40
Kartik Rao
leetrout
Lee Trout
balzack
Pierre Balzack

Sponsors

koconder
Vincent Koc
tbjers
Torgny Bjers
AnandChowdhary
Anand Chowdhary
shrippen
Shrippen
bile0026
Zach Biles
UlisesGascon
Ulises Gascón
digitalarche
Digital Archeology
InDieTasten
InDieTasten
araguaci
Araguaci
bmcgonag
Brian McGonagill
vlad-tim
Vlad
helixzz
HeliXZz
patvdv
Patrick Van Der Veken
mryesiller
Göksel Yeşiller
sushibait
Shiverme Timbers
forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023)
semiceau
GT
Bastii717
Bastii717
getumbrel
Umbrel
frankdez93
Frankdez93
terminaltrove
Terminal Trove
nrvo
Nrvo
hudsonrock-partnerships
Hudsonrock-partnerships

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 <alicia@omg.com> 

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 77.6%
  • HTML 16.9%
  • Makefile 4.0%
  • Dockerfile 1.5%