AS93

1,361
124
MIT
1 MB
Apr, 2023
1 day ago
Python

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. 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 {Shmolf}
  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. Immich {Shmolf}
  190. Influxdb
  191. Influxdb & Telegraf
  192. Influxdb 1.8.10
  193. Inkscape
  194. Invoice Ninja
  195. Iobroker
  196. Iperf
  197. Ironfunctions
  198. Ironfunctions Api
  199. Ironfunctions Ui
  200. Jackett
  201. Jdownloader
  202. Jellyfin
  203. Jellyfin-Accounts
  204. Jellyseer
  205. Jellyseerr
  206. Jenkins
  207. Jenkins-Builder
  208. Joomla
  209. Joplin
  210. Jump
  211. Kanzi
  212. Kapowarr
  213. Kasm
  214. Kavita
  215. Kdenlive
  216. Kicad
  217. Kimai
  218. Kiwix
  219. Klaxon
  220. Klipper[Testing], Mainsail, Moonraker
  221. Kodi Headless
  222. Koillection
  223. Komga
  224. Krita
  225. Lazylibrarian
  226. Lazytainer
  227. Ldap-Auth
  228. Leantime
  229. Let'S Encrypt / Swag
  230. Letsencrypt
  231. Libreddit
  232. Libreoffice
  233. Libresonic
  234. Librespeed
  235. Lidarr
  236. Limnoria
  237. Linkstack
  238. Littlelink Server
  239. Liveswitch
  240. Lldap
  241. Logzio Logs Collector
  242. Logzio Metrics Collector
  243. Lollypop
  244. Lychee
  245. Magento 2
  246. Magicmirror2
  247. Mailpile
  248. Maloja
  249. Mariadb
  250. Mastodon
  251. Matomo
  252. Mautic
  253. Mayan Edms
  254. Mcmyadmin 2
  255. Mealie
  256. Mediaelch
  257. Medusa
  258. Meilisearch
  259. Meshcentral
  260. Metube
  261. Microsoft Oms Agent
  262. Midarr
  263. Minecraft Server
  264. Minetest
  265. Miniflux
  266. Minio
  267. Minisatip
  268. Mongo
  269. Monica
  270. Moodle
  271. Mozilla Syncserver
  272. Mstream
  273. Mullvad-Browser
  274. Murmur
  275. Musicbrainz
  276. Muximux
  277. Mylar
  278. Mylar3
  279. Mysql
  280. Mysql-Workbench
  281. N8N
  282. Nano
  283. Nano-Wallet
  284. Navidrome
  285. Neko
  286. Netboot.Xyz
  287. Netbox
  288. Netdata
  289. Nextcloud
  290. Nextcloudstack
  291. Nginx
  292. Nginx Proxy Manager
  293. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  294. Nginx Proxy Manager V2 With Sqllite
  295. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  296. Ngircd
  297. Nitter
  298. Nocodb
  299. Nodejs
  300. Nodered
  301. Nord-Vpn
  302. Nut Server
  303. Nuts
  304. Nzbget
  305. Nzbhydra 2
  306. Octoprint
  307. Odoo
  308. Omada Eap Controller
  309. Ombi
  310. Opc Router
  311. Openamt
  312. Openbudgeteer
  313. Openfaas
  314. Openssh-Server
  315. Openvpn Access Server
  316. Openvpn-As
  317. Openvscode-Server
  318. Opera
  319. Orcaslicer
  320. Organizr
  321. Organizr V2
  322. Ory Kratos (Oathkeeper)
  323. Ory Kratos (Standalone)
  324. Oscam
  325. Outline
  326. Overseerr
  327. Owncloud
  328. Pairdrop
  329. Paperless Ngx
  330. Paperless-Ng
  331. Papermerge
  332. Passbolt
  333. Passky Client
  334. Passky Server
  335. Penpot (Http) {Shmolf}
  336. Petio
  337. Pgadmin
  338. Photoprism
  339. Photoshow
  340. Phpmyadmin
  341. Pi-Hole
  342. Pi-Hole Doh/Dot
  343. Pi-Hole-Unbound
  344. Pi.Alert
  345. Pidgin
  346. Pingvin Share
  347. Piper
  348. Piwigo
  349. Pixapop
  350. Pixel-Server
  351. Plane
  352. Plesk
  353. Plex
  354. Plex Media Server
  355. Plex Requests
  356. Plex-Meta-Manager
  357. Plextraktsync
  358. Plone
  359. Portainer Agent
  360. Poste.Io
  361. Postgresql
  362. Pritunl
  363. Privatebin
  364. Pro Mosquitto With Management Center
  365. Projectsend
  366. Protonmail Bridge
  367. Prowlarr
  368. Proxitok
  369. Pure-Ftp Server
  370. Pve-Exporter
  371. Pwndrop
  372. Pydio
  373. Pydio-Cells
  374. Pyload-Ng
  375. Pylon
  376. Qbittorrent
  377. Qdirstat
  378. Qflood
  379. Quassel Irc
  380. Quassel-Core
  381. Quassel-Web
  382. Rabbitmq
  383. Radarr
  384. Raneto
  385. Raspberry Pi Docker Monitor
  386. Rclone Config Backup
  387. Rdesktop
  388. Reactive-Resume
  389. Readarr
  390. Readme-Sync
  391. Redis
  392. Redis Cluster
  393. Redmine
  394. Registry
  395. Registry (Cache)
  396. Remmina
  397. Remotely
  398. Requestrr
  399. Resilio Sync
  400. Reveal.Js
  401. Rocket Chat
  402. Rport
  403. Rsnapshot
  404. Rust Desk
  405. Rutorrent
  406. Sabnzbd
  407. Samba
  408. Scality S3
  409. Scrutiny
  410. Searxng
  411. Sematext Docker Agent
  412. Series-Troxide
  413. Servas
  414. Shaarli
  415. Shiori
  416. Shotcut
  417. Sickchill
  418. Sickgear
  419. Sickrage
  420. Signal Proxy
  421. Silverstripe
  422. Smokeping
  423. Snapdrop
  424. Snibox
  425. Snipe-It
  426. Snippet Box
  427. Softing Edgeconnector 840D
  428. Softing Edgeconnector Aggregator
  429. Softing Edgeconnector Fanuc Cnc
  430. Softing Edgeconnector Modbus
  431. Softing Edgeconnector Siemens
  432. Solr
  433. Sonarr
  434. Speedtest Tracker
  435. Sql Server
  436. Sql Server Express
  437. Sqlitebrowser
  438. Sshwifty
  439. Stash
  440. Statping
  441. Steamos
  442. Stirling Pdf {Shmolf}
  443. Surrealdb
  444. Swag
  445. Swarm Monitoring
  446. Synclounge
  447. Syncthing
  448. Syslog-Ng
  449. System Stats Oled Display
  450. Tabby
  451. Tailscale
  452. Tandoor
  453. Tautulli
  454. Tdarr
  455. Teleport
  456. Terraria Server {Shmolf}
  457. Tester
  458. Thelounge
  459. Tiddlywiki
  460. Tiny Tiny Rss
  461. Tooljet
  462. Tosibox Lock For Container
  463. Traefik
  464. Traggo
  465. Transmission
  466. Transmission Openvpn Latest
  467. Transmission Openvpn V3
  468. Transmission-Openvpn
  469. Trilium
  470. Trudesk
  471. Tubearchivist
  472. Tvheadend
  473. Twitch Points Miner
  474. Ubooquity
  475. Ubuntu
  476. Umami.Is
  477. Unifi Controller
  478. Unifi Video
  479. Unifi-Network-Application
  480. Unmanic
  481. Unrar
  482. Upsnap
  483. Uptime Kuma
  484. Urbackup
  485. Urlwatch
  486. Vaultwarden
  487. Vikunja
  488. Vlmcsd - Kms
  489. Vscodium
  490. Vsftpd Ftp Server
  491. Wallabag
  492. Watchtower
  493. Watchtower {Shmolf}
  494. Webcord
  495. Webgrab+Plus
  496. Webtop
  497. Webtrees
  498. Wger
  499. Whisparr
  500. Whoogle
  501. Wikijs
  502. Wireguard
  503. Wireguard Server
  504. Wireshark
  505. Wizarr
  506. Wordpress
  507. Wowza
  508. Wps-Office
  509. Xbackbone
  510. Xwiki
  511. Yacht
  512. Your_Spotify
  513. Youtubedl-Material
  514. Yq
  515. Znc
  516. Zotero
  517. 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 [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
alydemah
Aly Mohamed
bgadrian
B.G.Adrian
tbjers
Torgny Bjers
emlazzarin
Eddy Lazzarin
AnandChowdhary
Anand Chowdhary
shrippen
Shrippen
bile0026
Zach Biles
UlisesGascon
Ulises Gascón
digitalarche
Digital Archeology
InDieTasten
InDieTasten
bmcgonag
Brian McGonagill
vlad-timofeev
Vlad Timofeev
helixzz
HeliXZz
forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023)
Bastii717
Bastii717
frankdez93
Frankdez93
ratty222
Brent
hernanpopper
Hernanpopper
NixyJuppie
Nixy
nrvo
Nrvo
mezza93
mezza93

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 :)