/portainer-templates

🚢 400+ 1-click Portainer app templates

Primary LanguagePythonMIT LicenseMIT

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. Adguardhome
  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. Changedetection
  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. Duckdns
  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. Filebrowser
  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. Htpcmanager
  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. Kasm
  192. Kavita
  193. Kdenlive
  194. Kiwix
  195. Klaxon
  196. Klipper[Testing], Mainsail, Moonraker
  197. Kodi-Headless
  198. Koillection
  199. Komga
  200. Lazylibrarian
  201. Lazytainer
  202. Ldap-Auth
  203. Leantime
  204. Let'S Encrypt / Swag
  205. Letsencrypt
  206. Libreddit
  207. Libreoffice
  208. Libresonic
  209. Librespeed
  210. Lidarr
  211. Limnoria
  212. Linkstack
  213. Littlelink Server
  214. Liveswitch
  215. Lldap
  216. Logzio Logs Collector
  217. Logzio Metrics Collector
  218. Lollypop
  219. Lychee
  220. Magento 2
  221. Magicmirror2
  222. Mailpile
  223. Maloja
  224. Mariadb
  225. Mastodon
  226. Matomo
  227. Mautic
  228. Mayan Edms
  229. Mcmyadmin 2
  230. Mealie
  231. Medusa
  232. Meilisearch
  233. Meshcentral
  234. Metube
  235. Microsoft Oms Agent
  236. Midarr
  237. Minecraft Server
  238. Minetest
  239. Miniflux
  240. Minio
  241. Minisatip
  242. Mongo
  243. Monica
  244. Moodle
  245. Mozilla Syncserver
  246. Mstream
  247. Mullvad-Browser
  248. Murmur
  249. Musicbrainz
  250. Muximux
  251. Mylar
  252. Mylar3
  253. Mysql
  254. Mysql-Workbench
  255. N8N
  256. Nano
  257. Nano-Wallet
  258. Navidrome
  259. Neko
  260. Netboot.Xyz
  261. Netbox
  262. Netdata
  263. Nextcloud
  264. Nextcloudstack
  265. Nginx
  266. Nginx Proxy Manager
  267. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  268. Nginx Proxy Manager V2 With Sqllite
  269. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  270. Ngircd
  271. Nitter
  272. Nntp2Nntp
  273. Nocodb
  274. Nodejs
  275. Nodered
  276. Nord-Vpn
  277. Nut Server
  278. Nuts
  279. Nzbget
  280. Nzbhydra2
  281. Octoprint
  282. Odoo
  283. Omada Eap Controller
  284. Ombi
  285. Opc Router
  286. Openamt
  287. Openbudgeteer
  288. Openfaas
  289. Openssh-Server
  290. Openvpn Access Server
  291. Openvpn-As
  292. Openvscode-Server
  293. Opera
  294. Organizr
  295. Organizr V2
  296. Ory Kratos (Oathkeeper)
  297. Ory Kratos (Standalone)
  298. Oscam
  299. Outline
  300. Overseerr
  301. Owncloud
  302. Pairdrop
  303. Paperless Ngx
  304. Paperless-Ng
  305. Papermerge
  306. Passky Client
  307. Passky Server
  308. Petio
  309. Pgadmin
  310. Photoprism
  311. Photoshow
  312. Phpmyadmin
  313. Pi-Hole
  314. Pi-Hole Doh/Dot
  315. Pi-Hole-Unbound
  316. Pi.Alert
  317. Pidgin
  318. Piwigo
  319. Pixapop
  320. Pixel-Server
  321. Plesk
  322. Plex
  323. Plex Media Server
  324. Plex Requests
  325. Plex-Meta-Manager
  326. Plextraktsync
  327. Plone
  328. Portainer Agent
  329. Poste.Io
  330. Postgresql
  331. Pritunl
  332. Privatebin
  333. Projectsend
  334. Protonmail Bridge
  335. Prowlarr
  336. Proxitok
  337. Pure-Ftp Server
  338. Pwndrop
  339. Pydio
  340. Pydio-Cells
  341. Pyload-Ng
  342. Pylon
  343. Qbittorrent
  344. Qdirstat
  345. Qflood
  346. Quassel Irc
  347. Quassel-Core
  348. Quassel-Web
  349. Rabbitmq
  350. Radarr
  351. Raneto
  352. Raspberry Pi Docker Monitor
  353. Rclone Config Backup
  354. Rdesktop
  355. Reactive-Resume
  356. Readarr
  357. Readme-Sync
  358. Redis
  359. Redis Cluster
  360. Redmine
  361. Registry
  362. Registry (Cache)
  363. Remmina
  364. Remotely
  365. Requestrr
  366. Resilio Sync
  367. Reveal.Js
  368. Rocket Chat
  369. Rport
  370. Rsnapshot
  371. Rustdesk
  372. Rutorrent
  373. Sabnzbd
  374. Samba
  375. Scality S3
  376. Scrutiny
  377. Searxng
  378. Sematext Docker Agent
  379. Servas
  380. Shiori
  381. Sickchill
  382. Sickgear
  383. Sickrage
  384. Signal Proxy
  385. Silverstripe
  386. Smokeping
  387. Snapdrop
  388. Snibox
  389. Snipe-It
  390. Snippet-Box
  391. Softing Edgeconnector 840D
  392. Softing Edgeconnector Modbus
  393. Softing Edgeconnector Siemens
  394. Solr
  395. Sonarr
  396. Speedtest Tracker
  397. Sql Server
  398. Sql Server Express
  399. Sqlitebrowser
  400. Sshwifty
  401. Stash
  402. Statping
  403. Surrealdb
  404. Swag
  405. Swarm Monitoring
  406. Synclounge
  407. Syncthing
  408. Syslog-Ng
  409. System Stats Oled Display
  410. Tabby
  411. Tailscale
  412. Tandoor
  413. Tautulli
  414. Tdarr
  415. Teleport
  416. Tester
  417. Thelounge
  418. Tiddlywiki
  419. Tiny Tiny Rss
  420. Tooljet
  421. Tosibox Lock For Container
  422. Traefik
  423. Traggo
  424. Transmission
  425. Transmission Openvpn Latest
  426. Transmission Openvpn V3
  427. Transmission-Openvpn
  428. Trilium
  429. Trudesk
  430. Tubearchivist
  431. Tvheadend
  432. Ubooquity
  433. Ubuntu
  434. Umami.Is
  435. Unifi Video
  436. Unifi-Controller
  437. Unmanic
  438. Upsnap
  439. Uptime Kuma
  440. Urbackup
  441. Urlwatch
  442. Vaultwarden
  443. Vikunja
  444. Vlmcsd - Kms
  445. Vscodium
  446. Vsftpd Ftp Server
  447. Wallabag
  448. Watchtower
  449. Webcord
  450. Webgrabplus
  451. Webtop
  452. Wger
  453. Whisparr
  454. Whoogle
  455. Wikijs
  456. Wireguard
  457. Wireguard Server
  458. Wireshark
  459. Wizarr
  460. Wordpress
  461. Wowza
  462. Wps-Office
  463. Xbackbone
  464. Xwiki
  465. Yacht
  466. Your_Spotify
  467. Youtubedl-Material
  468. Yq
  469. Znc
  470. 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

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