agentr14/portainer-templates
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
148 commits 1 branch 0 tags 966 KiB
  • Python 75.2%
  • HTML 18.7%
  • Makefile 4.4%
  • Dockerfile 1.7%
Find a file
Exact
Liss-Bot 9460c1aeb5 Updates template + source list in docs (auto-generated, on 19-Nov-2023)
2023-11-19 02:14:57 +00:00
.github Updates template + source list in docs (auto-generated, on 19-Nov-2023) 2023-11-19 02:14:57 +00:00
lib Ignores dirs 2023-04-24 20:03:50 +01:00
sources added the databag messaging service 2023-05-17 11:03:38 -07:00
Dockerfile Updates to Dockerfile 2023-04-23 22:36:00 +01:00
index.html Updates license and docs link in self-hosted index 2023-09-23 22:00:04 +01:00
LICENSE Adds license (MIT) 2023-04-24 23:50:42 +01:00
Makefile Updates the Makefile to update the readme 2023-04-18 18:46:39 +01:00
Schema.json Adds schema and validation script, for checking otuput 2023-04-16 13:06:59 +01:00
sources.csv Revert "Update sources.csv" 2023-09-02 23:23:17 +01:00
templates.json Updates templates (auto-generated, on 19-Nov-2023) 2023-11-19 02:14:57 +00:00

.github/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

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

Sponsors

tbjers
Torgny Bjers 		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

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