Portainer Templates

A compiled list of 500+ ready to go Portainer App templates

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
Usage
Self-Hosting
Editing
Included Apps
Sources
Raising Issues
Contributing
Website
Mirror
Credits
License

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

Log into your Portainer web UI
Under Settings --> App Templates, update the URL to
- https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
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

Adguard
Adguardhome
Adguardhome-Sync
Airsonic
Airsonic-Advanced
Alpine Xfce4 Novnc
Altus
Apache Httpd
Apprise-Api
Archisteamfarm
Archivebox
Ariang
Audacity
Audiobookshelf
Authelia
Authentik
Babybuddy
Bambustudio
Baserow
Bazarr
Beets
Bitwarden Rs
Blender
Boinc
Booksonic
Booksonic-Air
Bookstack
Budge
Build-Agent
Caddy
Calibre
Calibre Web
Calligra
Cardigann
Changedetection
Changedetection.Io
Chevereto
Chowdown
Chromium
Chrony Ntp
Ci
Clamav
Cloud Commander
Cloud9
Cloudflare Ddns
Cockpit {Shmolf}
Cockroachdb
Code Server
Codiad
Commandbox
Contentbox
Cops
Couchpotato
Cratedb
Cura
Daapd
Darktable
Dashmachine
Dashy
Datadog Agent
Davinci Postgres Server
Davos
Ddclient
Deemix
Deluge
Deluge Openvpn
Digikam
Dillinger
Diskover
Dokku
Dokuwiki
Domoticz
Doplarr
Doublecommander
Dozzle
Dradis
Draw.Io
Droppy
Drupal
Duckdns
Duplicacy
Duplicati
Eclipse Mosquitto Mqtt
Edgeconnector 840D
Edgeconnector Aggregator
Edgeconnector Fanuc Cnc
Edgeconnector Modbus
Edgeconnector Siemens
Elasticsearch
Emby
Embystat
Emulatorjs
Endlessh
Fail2Ban
Faster-Whisper
Fdo
Feed2Toot
Fenrus
Ferdium
Ffmpeg
Filebrowser
Filebrowser Latest
Filebrowser S6
Filerun
Filezilla
Firefox
Flame
Flame-Dashboard
Flaresolverr
Fleet
Flexget
Floating License Server
Foldingathome
Foundryvtt Server
Freeboard
Freecad
Freshrss
Frigate Nvr
Gaps
Gazee
Ghost
Ghostfolio
Gimp
Gitea
Github-Desktop
Gitlab Ce
Gitqlient
Go-Socks5-Proxy
Gotify
Grafana
Grav
Grocy
Guacamole
Habridge
Headphones
Healthchecks
Hedgedoc
Heimdall
Hishtory-Server
Homarr
Homarr-Secured
Home Assistant
Homebridge
Homebridge - Debian
Homepage
Homer
Htpc Manager
Httpd
Huginn
Hydra2
Immich {Shmolf}
Influxdb 1.8.10
Inkscape
Invoice Ninja
Iobroker
Ironfunctions
Ironfunctions Api
Ironfunctions Ui
Jackett
Jdownloader
Jellyfin
Jellyfin-Accounts
Jellyseerr
Jenkins
Jenkins-Builder
Joomla
Joplin
Kanzi
Kasm
Kavita
Kdenlive
Kicad
Kimai
Klaxon
Klipper[Testing], Mainsail, Moonraker
Kodi Headless
Komga
Krita
Lazylibrarian
Ldap-Auth
Let'S Encrypt / Swag
Letsencrypt
Libreddit
Libreoffice
Libresonic
Librespeed
Lidarr
Limnoria
Liveswitch
Lldap
Logzio Logs Collector
Logzio Metrics Collector
Lollypop
Lychee
Magento 2
Magicmirror2
Maloja
Mariadb
Mastodon
Mautic
Mayan Edms
Mcmyadmin 2
Mealie
Mediaelch
Medusa
Meshcentral
Metube
Microsoft Oms Agent
Minecraft Server
Minetest
Minio
Minisatip
Mongo
Monica
Mozilla Syncserver
Mstream
Mullvad-Browser
Murmur
Musicbrainz
Muximux
Mylar
Mylar3
Mysql
Mysql-Workbench
N8N
Nano
Nano-Wallet
Navidrome
Netboot.Xyz
Netbox
Netdata
Nextcloud
Nextcloudstack
Nginx
Nginx Proxy Manager
Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
Nginx Proxy Manager V2 With Sqllite
Nginx Proxy Manager V3 [Devel] Not Ready For Use
Ngircd
Nitter
Node Red
Nodejs
Nord-Vpn
Nut Server
Nzbget
Nzbhydra 2
Octoprint
Odoo
Omada Eap Controller
Ombi
Opc Router
Openamt
Openfaas
Openssh-Server
Openvpn Access Server
Openvpn-As
Openvscode-Server
Opera
Orcaslicer
Organizr
Organizr V2
Oscam
Outline
Overseerr
Owncloud
Pairdrop
Paperless Ngx
Paperless-Ng
Papermerge
Passbolt
Passky Client
Passky Server
Penpot (Http) {Shmolf}
Petio
Pgadmin
Photoshow
Phpmyadmin
Pi-Hole
Pi-Hole Doh/Dot
Pi-Hole-Unbound
Pi.Alert
Pidgin
Piper
Piwigo
Pixapop
Pixel-Server
Plesk
Plex
Plex Media Server
Plex Requests
Plex-Meta-Manager
Plextraktsync
Plone
Portainer Agent
Postgresql
Pritunl
Privatebin
Pro Mosquitto With Management Center
Projectsend
Protonmail Bridge
Prowlarr
Pure-Ftp Server
Pwndrop
Pydio
Pydio-Cells
Pyload-Ng
Pylon
Python
Qbittorrent
Qdirstat
Qflood
Quassel Irc
Quassel-Core
Quassel-Web
Rabbitmq
Radarr
Raneto
Raspberry Pi Docker Monitor
Rclone Config Backup
Rdesktop
Reactive-Resume
Readarr
Readme-Sync
Redis
Redis Cluster
Redmine
Registry
Registry (Cache)
Remmina
Requestrr
Resilio Sync
Rocket Chat
Rsnapshot
Rustdesk
Rutorrent
Sabnzbd
Samba
Scality S3
Scrutiny
Searxng
Sematext Docker Agent
Series-Troxide
Servas
Shiori
Shotcut
Sickchill
Sickgear
Sickrage
Smokeping
Snapdrop
Snibox
Snipe-It
Snippet-Box
Softing Edgeconnector 840D
Softing Edgeconnector Aggregator
Softing Edgeconnector Fanuc Cnc
Softing Edgeconnector Modbus
Softing Edgeconnector Siemens
Solr
Sonarr
Speedtest Tracker
Sql Server
Sql Server Express
Sqlitebrowser
Sshwifty
Stash
Steamos
Stirling Pdf {Shmolf}
Surrealdb
Swag
Swarm Monitoring
Synclounge
Syncthing
Syslog-Ng
System Stats Oled Display
Tailscale
Tautulli
Terraria Server {Shmolf}
Tester
Thelounge
Tiddlywiki
Tiny Tiny Rss
Tosibox Lock For Container
Traefik
Transmission
Transmission Openvpn Latest
Transmission Openvpn V3
Transmission-Openvpn
Trilium
Tvheadend
Twitch Points Miner
Ubooquity
Ubuntu
Unifi Controller
Unifi Video
Unifi-Network-Application
Unmanic
Unrar
Uptime Kuma
Urbackup
Urlwatch
Vaultwarden
Vikunja
Vlmcsd - Kms
Vscodium
Vsftpd Ftp Server
Wallabag
Watchtower
Watchtower {Shmolf}
Webcord
Webgrab+Plus
Webtop
Whoogle
Wikijs
Wireguard
Wireguard Server
Wireshark
Wizarr
Wordpress
Wowza
Wps-Office
Xbackbone
Yacht
Your-Spotify
Youtubedl-Material
Yq
Znc
Zotero

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.

Raising Issues

If you notice something not working as it should in any of the lib/ scripts, website code, README documentation, or workflows automations - then raise an issue or PR in this repository.

If you encounter an issue with any container included here, please raise a ticket/PR on the up-stream repo, not in this repository. This project simply compiles templates listed in the Sources into a single manifest, so once a fix has been pushed out upstream, it will be available here.

Contributing

Contributions of any kind are very welcome, and would be much appreciated. For Code of Conduct, see Contributor Convent.

Not a coder? You can still help, by raising bugs you find, updating docs, or consider sponsoring me on GitHub

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.

Before raising an issue or editing a template, please see the Raising Issues section above (TL;DR: changes need to be made upstream, NOT in this repo).

If you're new to open source, I've put together some guides in Git-In, 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

_{Alicia Bot}	_{Alicia Sykes}	_{Nicholas Browning}	_{Benjamin Ranson}	_{Gilbert Palau}	_{Kartik Rao}
_{Lee Trout}	_{Pierre Balzack}

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.

_{Vincent Koc}	_Peng1can	_{Aly Mohamed}	_B.G.Adrian	_{Torgny Bjers}	_{Eddy Lazzarin}
_{Anand Chowdhary}	_Shrippen	_{Zach Biles}	_{Ulises Gascón}	_{Digital Archeology}	_InDieTasten
_{Brian McGonagill}	_{Vlad Timofeev}	_HeliXZz	_{Göksel Yeşiller}	_{Forward Email - Open-source & Privacy-focused Email Service (2023)}	_Bastii717
_Frankdez93	_Brent	_Hernanpopper	_Nixy	_Nrvo	_Mezza93

duduws/portainer-templates