Skip to content

ealburg/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

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

github
GitHub 		koconder
Vincent Koc 		Admonstrator
Aaron Viehl 		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 		plgonzalezrx8
Pedro Gonzalez 		mryesiller
Göksel Yeşiller 		forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023)
Bastii717
Bastii717 		getumbrel
Umbrel 		M2TD
M2TD 		frankdez93
Frankdez93 		terminaltrove
Terminal Trove 		nrvo
Nrvo

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

portainer-templates.as93.net

Resources

Readme

License

MIT license

Code of conduct

Code of conduct
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

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