Skip to content

azrilamil/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

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

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

Sponsors

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 		iJasonWade
Jason Ash 		DRXAquosus
DRXAquosus 		Bastii717
Bastii717
ratty222
Brent 		jtfinley72
Jtfinley72 		aldrich8
Aldrich

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 75.2%
  • HTML 18.7%
  • Makefile 4.4%
  • Dockerfile 1.7%