Skip to content

sshtmc/portainer-templates

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 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. Docker-Compose
  81. Documize
  82. Dokku
  83. Dokuwiki
  84. Domoticz
  85. Doplarr
  86. Doublecommander
  87. Dozzle
  88. Dradis
  89. Draw.Io
  90. Droppy
  91. Drupal
  92. Duck Dns
  93. Duplicacy
  94. Duplicati
  95. Eclipse Mosquitto
  96. Eclipse Mosquitto Mqtt
  97. Edgeconnector 840D
  98. Edgeconnector Modbus
  99. Elasticsearch
  100. Emby
  101. Embystat
  102. Emulatorjs
  103. Endlessh
  104. Eufy Security Ws
  105. Excalidraw
  106. Fail2Ban
  107. Fdo
  108. Feed2Toot
  109. Fenrus
  110. Ferdi Server
  111. Ferdium
  112. Ffmpeg
  113. Filebrowser
  114. Filebrowser Latest
  115. Filebrowser S6
  116. Filepizza
  117. Filerun
  118. Filestash
  119. Filezilla
  120. Firefox
  121. Fireshare
  122. Flame
  123. Flame-Dashboard
  124. Flaresolverr
  125. Fleet
  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. Gitea
  140. Gitea With Mariadb
  141. Github-Desktop
  142. Gitlab Ce
  143. Gitqlient
  144. Glances
  145. Go-Socks5-Proxy
  146. Gokapi
  147. Gotify
  148. Grafana
  149. Grav
  150. Grocy
  151. Guacamole
  152. Guacd
  153. Habridge
  154. Hasty-Paste
  155. Headphones
  156. Healthchecks
  157. Hedgedoc
  158. Heimdall
  159. Hishtory-Server
  160. Homarr
  161. Homarr-Secured
  162. Homeassistant
  163. Homebridge
  164. Homebridge - Debian
  165. Homechart
  166. Homepage
  167. Homer
  168. Htpc Manager
  169. Httpd
  170. Huginn
  171. Hydra2
  172. I Hate Money
  173. Immich
  174. Influxdb
  175. Influxdb & Telegraf
  176. Influxdb 1.8.10
  177. Invoice Ninja
  178. Iobroker
  179. Iperf
  180. Ipfs
  181. Ironfunctions
  182. Ironfunctions Api
  183. Ironfunctions Ui
  184. Jackett
  185. Jdownloader
  186. Jellyfin
  187. Jellyfin-Accounts
  188. Jellyseer
  189. Jellyseerr
  190. Jenkins
  191. Jenkins-Builder
  192. Joomla
  193. Joplin
  194. Jump
  195. Kanzi
  196. Kasm
  197. Kavita
  198. Kdenlive
  199. Klaxon
  200. Klipper[Testing], Mainsail, Moonraker
  201. Kodi Headless
  202. Koillection
  203. Komga
  204. Lazylibrarian
  205. Lazytainer
  206. Ldap-Auth
  207. Leantime
  208. Let'S Encrypt
  209. Let'S Encrypt / Swag
  210. Let'S Encrypt [Deprecated]
  211. Libreddit
  212. Libreoffice
  213. Libresonic
  214. Librespeed
  215. Lidarr
  216. Limnoria
  217. Littlelink Server
  218. Liveswitch
  219. Lldap
  220. Logzio Logs Collector
  221. Logzio Metrics Collector
  222. Lollypop
  223. Lychee
  224. Lychee With Mariadb
  225. Magento 2
  226. Magicmirror2
  227. Mailpile
  228. Maloja
  229. Mariadb
  230. Mastodon
  231. Matomo
  232. Mautic
  233. Mayan Edms
  234. Mcmyadmin 2
  235. Mealie
  236. Medusa
  237. Meilisearch
  238. Meshcentral
  239. Metube
  240. Microsoft Oms Agent
  241. Midarr
  242. Minecraft Server
  243. Minetest
  244. Miniflux
  245. Minio
  246. Minisatip
  247. Mongo
  248. Monica
  249. Moodle
  250. Mozilla Syncserver
  251. Mstream
  252. Mullvad-Browser
  253. Murmur
  254. Musicbrainz
  255. Muximux
  256. Mylar
  257. Mylar3
  258. Mysql
  259. Mysql-Workbench
  260. N8N
  261. Nano
  262. Nano-Wallet
  263. Navidrome
  264. Neko
  265. Netbootxyz
  266. Netbox
  267. Netdata
  268. Nextcloud
  269. Nextcloudpi
  270. Nextcloudstack
  271. Nginx
  272. Nginx Proxy Manager
  273. Nginx Proxy Manager V2 With Mysql [Deprecated]
  274. Nginx Proxy Manager V2 With Mysql And Goaccess Charts [Deprecated]
  275. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  276. Nginx Proxy Manager V2 With Sqllite
  277. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  278. Ngircd
  279. Nitter
  280. Nntp2Nntp
  281. Nocodb
  282. Node Red
  283. Nodejs
  284. Nord-Vpn
  285. Nut Server
  286. Nuts
  287. Nzbget
  288. Nzbhydra 2
  289. Octoprint
  290. Odoo
  291. Omada Eap Controller
  292. Ombi
  293. Opc Router
  294. Openamt
  295. Openbudgeteer
  296. Openfaas
  297. Openssh-Server
  298. Openvpn Access Server
  299. Openvpn-As
  300. Openvscode-Server
  301. Opera
  302. Organizr
  303. Organizr V2
  304. Ory Kratos (Oathkeeper)
  305. Ory Kratos (Standalone)
  306. Oscam
  307. Outline
  308. Overseerr
  309. Owncloud
  310. Pairdrop
  311. Paperless
  312. Paperless Ngx
  313. Paperless-Ng
  314. Papermerge
  315. Peppermint
  316. Petio
  317. Pgadmin
  318. Photoprism
  319. Photoshow
  320. Phpmyadmin
  321. Pi-Hole
  322. Pi-Hole Doh/Dot
  323. Pi-Hole-Unbound
  324. Pi.Alert
  325. Pidgin
  326. Piwigo
  327. Pixapop
  328. Pixel-Server
  329. Plesk
  330. Plex
  331. Plex Media Server
  332. Plex Requests
  333. Plex-Meta-Manager
  334. Plone
  335. Portainer Agent
  336. Poste.Io
  337. Postgresql
  338. Pritunl
  339. Privatebin
  340. Projectsend
  341. Protonmail Bridge
  342. Prowlarr
  343. Proxitok
  344. Pure-Ftp Server
  345. Pwndrop
  346. Pydio
  347. Pydio-Cells
  348. Pyload-Ng
  349. Pylon
  350. Qbittorrent
  351. Qdirstat
  352. Qflood
  353. Quassel Irc
  354. Quassel-Core
  355. Quassel-Web
  356. Rabbitmq
  357. Radarr
  358. Raneto
  359. Raspberry Pi Docker Monitor
  360. Rclone Config Backup
  361. Rdesktop
  362. Reactive-Resume
  363. Readarr
  364. Readme-Sync
  365. Redis
  366. Redis Cluster
  367. Redmine
  368. Registry
  369. Registry (Cache)
  370. Remmina
  371. Remotely
  372. Requestrr
  373. Resilio Sync
  374. Reveal.Js
  375. Rocket Chat
  376. Rport
  377. Rsnapshot
  378. Rust Desk
  379. Rutorrent
  380. Sabnzbd
  381. Samba
  382. Scality S3
  383. Scrutiny
  384. Searxng
  385. Sematext Docker Agent
  386. Servas
  387. Shiori
  388. Sickchill
  389. Sickgear
  390. Sickrage
  391. Signal Proxy
  392. Silverstripe
  393. Smokeping
  394. Snapdrop
  395. Snibox
  396. Snipe-It
  397. Snippet-Box
  398. Softing Edgeconnector 840D
  399. Softing Edgeconnector Modbus
  400. Solr
  401. Sonarr
  402. Speedtest Tracker
  403. Sql Server
  404. Sql Server Express
  405. Sqlitebrowser
  406. Sshwifty
  407. Stash
  408. Statping
  409. Surrealdb
  410. Swag
  411. Swag - Secure Web Application Gateway
  412. Swarm Monitoring
  413. Synclounge
  414. Syncthing
  415. Syslog-Ng
  416. System Stats Oled Display
  417. Tabby
  418. Tailscale
  419. Taisun
  420. Tandoor
  421. Tautulli
  422. Tdarr
  423. Teleport
  424. Tester
  425. Thelounge
  426. Tiddlywiki
  427. Tiny Tiny Rss
  428. Tooljet
  429. Tosibox Lock For Container
  430. Traefik
  431. Traggo
  432. Transmission
  433. Transmission Openvpn Latest
  434. Transmission Openvpn V3
  435. Transmission Openvpn Version 4
  436. Transmission-Openvpn
  437. Trilium
  438. Trudesk
  439. Tubearchivist
  440. Tvheadend
  441. Ubooquity
  442. Ubuntu
  443. Umami.Is
  444. Unifi Controller
  445. Unifi Video
  446. Unmanic
  447. Unpoller Monitor
  448. Upsnap
  449. Uptime Kuma
  450. Urbackup
  451. Urlwatch
  452. Vaultwarden
  453. Vikunja
  454. Vikunja With Frontend
  455. Vlmcsd - Kms
  456. Vscodium
  457. Vsftpd Ftp Server
  458. Wallabag
  459. Watchtower
  460. Webcord
  461. Webgrab+Plus
  462. Webtop
  463. Wger
  464. Whisparr
  465. Whoogle
  466. Wikijs
  467. Windows 2000
  468. Wireguard
  469. Wireguard Server
  470. Wireshark
  471. Wizarr
  472. Wordpress
  473. Wowza
  474. Wps-Office
  475. Xbackbone
  476. Xwiki
  477. Yacht
  478. Your_Spotify
  479. Yourls
  480. Youtubedl-Material
  481. Yq
  482. Znc
  483. 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 [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

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

About

🚢 400+ 1-click Portainer app templates

portainer-templates.as93.net

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 79.9%
  • HTML 13.6%
  • Makefile 4.7%
  • Dockerfile 1.8%