romanmir/portainer-templates
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
7605e462ff8927a54cf27d670c3060028c16ef68
portainer-templates/.github
History
Alicia Sykes 7605e462ff Update README.md
2023-04-22 22:45:03 +01:00
..
workflows
Don't exit prematurley
2023-04-18 18:50:54 +01:00
README.md
Update README.md
2023-04-22 22:45:03 +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. Lychee
  219. Lychee With Mariadb
  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. Netbootxyz
  261. Netbox
  262. Netdata
  263. Nextcloud
  264. Nextcloudpi
  265. Nextcloudstack
  266. Nginx
  267. Nginx Proxy Manager
  268. Nginx Proxy Manager V2 With Mysql [Deprecated]
  269. Nginx Proxy Manager V2 With Mysql And Goaccess Charts [Deprecated]
  270. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  271. Nginx Proxy Manager V2 With Sqllite
  272. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  273. Ngircd
  274. Nitter
  275. Nntp2Nntp
  276. Nocodb
  277. Node Red
  278. Nodejs
  279. Nord-Vpn
  280. Nut Server
  281. Nuts
  282. Nzbget
  283. Nzbhydra 2
  284. Octoprint
  285. Odoo
  286. Omada Eap Controller
  287. Ombi
  288. Opc Router
  289. Openamt
  290. Openbudgeteer
  291. Openfaas
  292. Openssh-Server
  293. Openvpn Access Server
  294. Openvpn-As
  295. Openvscode-Server
  296. Opera
  297. Organizr
  298. Organizr V2
  299. Ory Kratos (Oathkeeper)
  300. Ory Kratos (Standalone)
  301. Oscam
  302. Overseerr
  303. Owncloud
  304. Pairdrop
  305. Paperless
  306. Paperless Ngx
  307. Paperless-Ng
  308. Papermerge
  309. Peppermint
  310. Petio
  311. Pgadmin
  312. Photoprism
  313. Photoshow
  314. Phpmyadmin
  315. Pi-Hole
  316. Pi-Hole Doh/Dot
  317. Pi-Hole-Unbound
  318. Pi.Alert
  319. Pidgin
  320. Piwigo
  321. Pixapop
  322. Pixel-Server
  323. Plesk
  324. Plex
  325. Plex Media Server
  326. Plex Requests
  327. Plex-Meta-Manager
  328. Plone
  329. Portainer Agent
  330. Poste.Io
  331. Postgresql
  332. Pritunl
  333. Privatebin
  334. Projectsend
  335. Protonmail Bridge
  336. Prowlarr
  337. Proxitok
  338. Pure-Ftp Server
  339. Pwndrop
  340. Pydio
  341. Pydio-Cells
  342. Pyload-Ng
  343. Pylon
  344. Qbittorrent
  345. Qdirstat
  346. Qflood
  347. Quassel Irc
  348. Quassel-Core
  349. Quassel-Web
  350. Rabbitmq
  351. Radarr
  352. Raneto
  353. Raspberry Pi Docker Monitor
  354. Rclone Config Backup
  355. Rdesktop
  356. Reactive-Resume
  357. Readarr
  358. Readme-Sync
  359. Redis
  360. Redis Cluster
  361. Redmine
  362. Registry
  363. Registry (Cache)
  364. Remmina
  365. Remotely
  366. Requestrr
  367. Resilio-Sync
  368. Reveal.Js
  369. Rocket Chat
  370. Rport
  371. Rsnapshot
  372. Rust Desk
  373. Rutorrent
  374. Sabnzbd
  375. Samba
  376. Scality S3
  377. Scrutiny
  378. Searxng
  379. Sematext Docker Agent
  380. Servas
  381. Shiori
  382. Sickchill
  383. Sickgear
  384. Sickrage
  385. Signal Proxy
  386. Silverstripe
  387. Smokeping
  388. Snapdrop
  389. Snibox
  390. Snipe-It
  391. Snippet-Box
  392. Softing Edgeconnector Modbus
  393. Solr
  394. Sonarr
  395. Speedtest Tracker
  396. Sql Server
  397. Sql Server Express
  398. Sqlitebrowser
  399. Sshwifty
  400. Stash
  401. Statping
  402. Surrealdb
  403. Swag
  404. Swag - Secure Web Application Gateway
  405. Synclounge
  406. Syncthing
  407. Syslog-Ng
  408. System Stats Oled Display
  409. Tabby
  410. Tailscale
  411. Taisun
  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 Version 4
  426. Transmission-Openvpn
  427. Trilium
  428. Trudesk
  429. Tvheadend
  430. Ubooquity
  431. Ubuntu
  432. Umami.Is
  433. Unifi Video
  434. Unifi-Controller
  435. Unmanic
  436. Unpoller Monitor
  437. Upsnap
  438. Uptime Kuma
  439. Urbackup
  440. Urlwatch
  441. Vaultwarden
  442. Vikunja
  443. Vikunja With Frontend
  444. Vlmcsd - Kms
  445. Vscodium
  446. Vsftpd Ftp Server
  447. Wallabag
  448. Watchtower
  449. Webgrabplus
  450. Webtop
  451. Wger
  452. Whisparr
  453. Whoogle
  454. Wikijs
  455. Windows 2000
  456. Wireguard
  457. Wireguard Server
  458. Wireshark
  459. Wizarr
  460. Wordpress
  461. Wowza
  462. Xbackbone
  463. Xwiki
  464. Yacht
  465. Your_Spotify
  466. Yourls
  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

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.

Disclaimer

License

© Alicia Sykes 2023
Licensed under MIT

Thanks for visiting :)

Reference in New Issue View Git Blame Copy Permalink