romanmir/portainer-templates
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
d7d7add504b5aa60e136ffd3577c063731e1a63d
portainer-templates/.github
History
Alicia Sykes d7d7add504 Update publish-docker.yml
2023-04-23 22:18:00 +01:00
..
workflows
Update publish-docker.yml
2023-04-23 22:18:00 +01:00
README.md
Adds link to non-GH mirror + updates license content
2023-04-23 16:54:13 +01:00

README.md

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

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

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 running a fork of this repo, don't forget to replace [lissy93] with your own username.

Your templates file will then be served up, at: http://docker-host:8080/templates.json

Or, to mount the templates.json file to your container, so that you can make changes to it, and have them show up within Portainer

docker run -d -p "8080:80" -v "${PWD}/templates.json:/usr/share/nginx/html/templates.json" portainer-templates

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

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

Reference in New Issue View Git Blame Copy Permalink