Skip to content

100nandoo/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

236 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. 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. Audacity
  21. Audiobookshelf
  22. Authelia
  23. Authentik
  24. Autobrr
  25. Babybuddy
  26. Baikal
  27. Bambustudio
  28. Baserow
  29. Bazarr
  30. Beets
  31. Beszel
  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. Cloudflared
  62. Cockroachdb
  63. Code Server
  64. Codex
  65. Codiad
  66. Commandbox
  67. Contentbox
  68. Cops
  69. Couchpotato
  70. Cratedb
  71. Cryptofolio
  72. Cura
  73. Daapd
  74. Darktable
  75. Dashdot
  76. Dashmachine
  77. Dashy
  78. Datadog Agent
  79. Davinci Postgres Server
  80. Davos
  81. Ddclient
  82. Deemix
  83. Deluge
  84. Deluge Openvpn
  85. Digikam
  86. Diskover
  87. Docker Container Stats
  88. Dockge
  89. Documize
  90. Dokemon
  91. Dokku
  92. Dokuwiki
  93. Domoticz
  94. Doplarr
  95. Doublecommander
  96. Dozzle
  97. Dradis
  98. Draw.Io
  99. Droppy
  100. Drupal
  101. Duckdns
  102. Duplicacy
  103. Duplicati
  104. Eclipse Mosquitto Mqtt
  105. Edgeconnector 840D
  106. Edgeconnector Aggregator
  107. Edgeconnector Fanuc Cnc
  108. Edgeconnector Modbus
  109. Edgeconnector Siemens
  110. Elasticsearch
  111. Emby
  112. Embystat
  113. Emulatorjs
  114. Endlessh
  115. Eufy Security Ws
  116. Excalidraw
  117. Fail2Ban
  118. Faster-Whisper
  119. Fdo
  120. Feed2Toot
  121. Feedcord
  122. Fenrus
  123. Ferdi Server
  124. Ferdium
  125. Fetchcord
  126. Ffmpeg
  127. Filebrowser
  128. Filebrowser Latest
  129. Filebrowser Mine
  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. Fusion
  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. Hoarder
  182. Homarr
  183. Homarr-Secured
  184. Homeassistant
  185. Homebridge
  186. Homebridge - Debian
  187. Homechart
  188. Homepage
  189. Homer
  190. Htpc Manager
  191. Httpd
  192. Huginn
  193. Hydra2
  194. I Hate Money
  195. Immich
  196. Influxdb
  197. Influxdb & Telegraf
  198. Influxdb 1.8.10
  199. Inkscape
  200. Invidious
  201. Invoice Ninja
  202. Iobroker
  203. Iperf
  204. Ironfunctions
  205. Ironfunctions Api
  206. Ironfunctions Ui
  207. Jackett
  208. Jdownloader
  209. Jellyfin
  210. Jellyfin-Accounts
  211. Jellyseer
  212. Jellyseerr
  213. Jenkins
  214. Jenkins-Builder
  215. Jmusicbot
  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. Markopolis
  265. Mastodon
  266. Matomo
  267. Mautic
  268. Mayan Edms
  269. Mcmyadmin 2
  270. Mealie
  271. Medama
  272. Mediaelch
  273. Medusa
  274. Meilisearch
  275. Meshcentral
  276. Metube
  277. Microsoft Oms Agent
  278. Midarr
  279. Minecraft Server
  280. Minetest
  281. Miniflux
  282. Minio
  283. Minisatip
  284. Mongo
  285. Monica
  286. Moodle
  287. Mozilla Syncserver
  288. Msedge
  289. Mstream
  290. Mullvad-Browser
  291. Murmur
  292. Musicbrainz
  293. Muximux
  294. Mylar
  295. Mylar3
  296. Mysql
  297. Mysql-Workbench
  298. N8N
  299. Nano
  300. Nano-Wallet
  301. Navidrome
  302. Neko
  303. Netalertx
  304. Netboot.Xyz
  305. Netbox
  306. Netdata
  307. Nextcloud
  308. Nextcloudstack
  309. Nginx
  310. Nginx Proxy Manager
  311. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  312. Nginx Proxy Manager V2 With Sqllite
  313. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  314. Ngircd
  315. Nitter
  316. Nocodb
  317. Nodejs
  318. Nodered
  319. Nord-Vpn
  320. Nut Server
  321. Nuts
  322. Nzbget
  323. Nzbhydra 2
  324. Obsidian
  325. Octoprint
  326. Odoo
  327. Omada Eap Controller
  328. Ombi
  329. Opc Router
  330. Openamt
  331. Openbudgeteer
  332. Openfaas
  333. Openssh-Server
  334. Openvpn Access Server
  335. Openvpn-As
  336. Openvscode-Server
  337. Opera
  338. Opnform
  339. Orcaslicer
  340. Organizr
  341. Organizr V2
  342. Ory Kratos (Oathkeeper)
  343. Ory Kratos (Standalone)
  344. Oscam
  345. Outline
  346. Overseerr
  347. Owncloud
  348. Pairdrop
  349. Paperless Ngx
  350. Paperless-Ng
  351. Papermerge
  352. Passbolt
  353. Passky Client
  354. Passky Server
  355. Petio
  356. Pgadmin
  357. Photoprism
  358. Photoshow
  359. Phpmyadmin
  360. Pi-Hole
  361. Pi-Hole Doh/Dot
  362. Pi-Hole-Unbound
  363. Pi.Alert
  364. Pidgin
  365. Pingvin
  366. Piper
  367. Piwigo
  368. Pixapop
  369. Pixel-Server
  370. Plane
  371. Planka
  372. Plesk
  373. Plex
  374. Plex Media Server
  375. Plex Requests
  376. Plextraktsync
  377. Plone
  378. Portainer Agent
  379. Poste.Io
  380. Postgresql
  381. Pritunl
  382. Privatebin
  383. Pro Mosquitto With Management Center
  384. Projectsend
  385. Protonmail Bridge
  386. Prowlarr
  387. Proxitok
  388. Pure-Ftp Server
  389. Pve-Exporter
  390. Pwndrop
  391. Pydio
  392. Pydio-Cells
  393. Pyload-Ng
  394. Pylon
  395. Python
  396. Qbittorrent
  397. Qdirstat
  398. Qemu-Static
  399. Qflood
  400. Quassel Irc
  401. Quassel-Core
  402. Quassel-Web
  403. Rabbitmq
  404. Radarr
  405. Raneto
  406. Raspberry Pi Docker Monitor
  407. Rawtherapee
  408. Rclone Config Backup
  409. Rdesktop
  410. Reactive-Resume
  411. Readarr
  412. Readme-Sync
  413. Redis
  414. Redis Cluster
  415. Redmine
  416. Registry
  417. Registry (Cache)
  418. Remmina
  419. Remotely
  420. Resilio Sync
  421. Reveal.Js
  422. Rocket Chat
  423. Rport
  424. Rsnapshot
  425. Rustdesk
  426. Rutorrent
  427. Sabnzbd
  428. Samba
  429. Scality S3
  430. Scrutiny
  431. Searxng
  432. Sematext Docker Agent
  433. Series-Troxide
  434. Servas
  435. Shaarli
  436. Shiori
  437. Shotcut
  438. Sickchill
  439. Sickgear
  440. Sickrage
  441. Signal Proxy
  442. Silverstripe
  443. Smokeping
  444. Snapdrop
  445. Snibox
  446. Snipe-It
  447. Snippet-Box
  448. Socket-Proxy
  449. Softing Edgeconnector 840D
  450. Softing Edgeconnector Aggregator
  451. Softing Edgeconnector Fanuc Cnc
  452. Softing Edgeconnector Modbus
  453. Softing Edgeconnector Siemens
  454. Solr
  455. Sonarr
  456. Speedtest Tracker
  457. Spotube
  458. Sql Server
  459. Sql Server Express
  460. Sqlitebrowser
  461. Sshwifty
  462. Stash
  463. Statping
  464. Steamos
  465. Stirling-Pdf
  466. Surrealdb
  467. Swag
  468. Swarm Monitoring
  469. Synclounge
  470. Syncthing
  471. Syslog-Ng
  472. System Stats Oled Display
  473. Tabby
  474. Tailscale
  475. Tandoor
  476. Tautulli
  477. Tdarr
  478. Telegram Bot
  479. Teleport
  480. Tester
  481. Thelounge
  482. Tiddlywiki
  483. Timetagger
  484. Tiny Tiny Rss
  485. Tinymediamanager
  486. Tooljet
  487. Tosibox Lock For Container
  488. Traefik
  489. Traggo
  490. Transmission
  491. Transmission Openvpn Latest
  492. Transmission Openvpn V3
  493. Transmission-Openvpn
  494. Trilium
  495. Trudesk
  496. Tubearchivist
  497. Tvheadend
  498. Twitch Points Miner
  499. Ubooquity
  500. Ubuntu
  501. Umami.Is
  502. Ungoogled-Chromium
  503. Unifi Controller
  504. Unifi Video
  505. Unifi-Network-Application
  506. Unmanic
  507. Unrar
  508. Upsnap
  509. Uptime Kuma
  510. Urbackup
  511. Urlwatch
  512. Vaultwarden
  513. Vikunja
  514. Vlmcsd - Kms
  515. Vscodium
  516. Vsftpd Ftp Server
  517. Wallabag
  518. Watchtower
  519. Web Check
  520. Webcord
  521. Webgrab+Plus
  522. Webtop
  523. Webtrees
  524. Wger
  525. Whisparr
  526. Whoogle
  527. Wikijs
  528. Wireguard
  529. Wireguard Server
  530. Wireshark
  531. Wizarr
  532. Wordpress
  533. Wowza
  534. Wps-Office
  535. Xbackbone
  536. Xwiki
  537. Yaak
  538. Yacht
  539. Your_Spotify
  540. Youtubedl-Material
  541. Yq
  542. Znc
  543. Zotero
  544. 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

liss-bot
Alicia Bot 		Lissy93
Alicia Sykes 		Benoniy
Benjamin Ranson 		100nandoo
Fernando F. H. 		tempusthales
Gilbert Palau 		kr40
Kartik Rao
leetrout
Lee Trout 		balzack
Pierre Balzack

Sponsors

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

🚢 400+ 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

1 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages

  • Python 75.2%
  • HTML 18.7%
  • Makefile 4.4%
  • Dockerfile 1.7%