A compiled list of 500+ 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
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
- 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.
Alternatively, when you start Portainer, you can append the --templates
flag pointing to the templates URL.
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"
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.
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.
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.
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.
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.
↕️ Click to Expand ↕️
Click an item, to see stats, config options and installation instructions
- Activepieces -- (Report issues)
- Actual -- (Report issues)
- Adguard -- (Report issues)
- Adguardhome -- (Report issues)
- Adguardhome-Sync -- (Report issues)
- Airsonic -- (Report issues)
- Airsonic-Advanced -- (Report issues)
- Alpine Xfce4 Novnc -- (Report issues)
- Altus -- (Report issues)
- Ansible-Semaphore -- (Report issues)
- Apache Httpd -- (Report issues)
- Apprise-Api -- (Report issues)
- Appsmith -- (Report issues)
- Appwrite -- (Report issues)
- Archisteamfarm -- (Report issues)
- Archivebox -- (Report issues)
- Ardour -- (Report issues)
- Aria2 Pro -- (Report issues)
- Ariang -- (Report issues)
- Asciinema {Shmolf} -- (Report issues)
- Audacity -- (Report issues)
- Audiobookshelf -- (Report issues)
- Authelia -- (Report issues)
- Authentik -- (Report issues)
- Autobrr -- (Report issues)
- Babybuddy -- (Report issues)
- Baikal -- (Report issues)
- Bambustudio -- (Report issues)
- Baserow -- (Report issues)
- Bazarr -- (Report issues)
- Beets -- (Report issues)
- Beszel -- (Report issues)
- Bitwarden Rs -- (Report issues)
- Blender -- (Report issues)
- Boinc -- (Report issues)
- Booksonic -- (Report issues)
- Booksonic-Air -- (Report issues)
- Bookstack -- (Report issues)
- Broadlink Manager -- (Report issues)
- Budge -- (Report issues)
- Budibase -- (Report issues)
- Build-Agent -- (Report issues)
- Caddy -- (Report issues)
- Calibre -- (Report issues)
- Calibre Web -- (Report issues)
- Calligra -- (Report issues)
- Cardigann -- (Report issues)
- Castopod -- (Report issues)
- Changedetection -- (Report issues)
- Changedetection.Io -- (Report issues)
- Chevereto -- (Report issues)
- Chibisafe -- (Report issues)
- Chiefonboarding -- (Report issues)
- Chowdown -- (Report issues)
- Chromium -- (Report issues)
- Chrony Ntp -- (Report issues)
- Ci -- (Report issues)
- Clamav -- (Report issues)
- Cloud Commander -- (Report issues)
- Cloud9 -- (Report issues)
- Cloudflare Ddns -- (Report issues)
- Cockpit {Shmolf} -- (Report issues)
- Cockroachdb -- (Report issues)
- Code Server -- (Report issues)
- Code-Server {Shmolf} -- (Report issues)
- Codex -- (Report issues)
- Codiad -- (Report issues)
- Commandbox -- (Report issues)
- Contentbox -- (Report issues)
- Cops -- (Report issues)
- Couchpotato -- (Report issues)
- Cratedb -- (Report issues)
- Cryptofolio -- (Report issues)
- Cura -- (Report issues)
- D2-Builder -- (Report issues)
- Daapd -- (Report issues)
- Darktable -- (Report issues)
- Dashdot -- (Report issues)
- Dashmachine -- (Report issues)
- Dashy -- (Report issues)
- Datadog Agent -- (Report issues)
- Davinci Postgres Server -- (Report issues)
- Davos -- (Report issues)
- Ddclient -- (Report issues)
- Deemix -- (Report issues)
- Deluge -- (Report issues)
- Deluge Openvpn -- (Report issues)
- Digikam -- (Report issues)
- Diskover -- (Report issues)
- Docker Container Stats -- (Report issues)
- Dockge -- (Report issues)
- Documize -- (Report issues)
- Dokemon -- (Report issues)
- Dokku -- (Report issues)
- Dokuwiki -- (Report issues)
- Domoticz -- (Report issues)
- Doplarr -- (Report issues)
- Doublecommander -- (Report issues)
- Dozzle -- (Report issues)
- Dradis -- (Report issues)
- Draw.Io -- (Report issues)
- Droppy -- (Report issues)
- Drupal -- (Report issues)
- Duckdns -- (Report issues)
- Duplicacy -- (Report issues)
- Duplicati -- (Report issues)
- Eclipse Mosquitto Mqtt -- (Report issues)
- Edgeconnector 840D -- (Report issues)
- Edgeconnector Aggregator -- (Report issues)
- Edgeconnector Fanuc Cnc -- (Report issues)
- Edgeconnector Modbus -- (Report issues)
- Edgeconnector Siemens -- (Report issues)
- Elasticsearch -- (Report issues)
- Emby -- (Report issues)
- Embystat -- (Report issues)
- Emulatorjs -- (Report issues)
- Endlessh -- (Report issues)
- Eufy Security Ws -- (Report issues)
- Excalidraw -- (Report issues)
- Fail2Ban -- (Report issues)
- Faster-Whisper -- (Report issues)
- Fdo -- (Report issues)
- Feed2Toot -- (Report issues)
- Feedcord -- (Report issues)
- Fenrus -- (Report issues)
- Ferdi Server -- (Report issues)
- Ferdium -- (Report issues)
- Fetchcord -- (Report issues)
- Ffmpeg -- (Report issues)
- Filebrowser -- (Report issues)
- Filebrowser Latest -- (Report issues)
- Filebrowser S6 -- (Report issues)
- Filepizza -- (Report issues)
- Filerun -- (Report issues)
- Filestash -- (Report issues)
- Filezilla -- (Report issues)
- Firefox -- (Report issues)
- Fireshare -- (Report issues)
- Flame -- (Report issues)
- Flame-Dashboard -- (Report issues)
- Flaresolverr -- (Report issues)
- Fleet -- (Report issues)
- Flexget -- (Report issues)
- Floating License Server -- (Report issues)
- Flood -- (Report issues)
- Flowiseai -- (Report issues)
- Foldingathome -- (Report issues)
- Foundryvtt Server -- (Report issues)
- Freeboard -- (Report issues)
- Freecad -- (Report issues)
- Freescout -- (Report issues)
- Freetube -- (Report issues)
- Freshrss -- (Report issues)
- Frigate Nvr -- (Report issues)
- Funkwhale -- (Report issues)
- Fusion -- (Report issues)
- Gaps -- (Report issues)
- Gathio -- (Report issues)
- Gazee -- (Report issues)
- Ghost -- (Report issues)
- Ghostfolio -- (Report issues)
- Gimp -- (Report issues)
- Gitea -- (Report issues)
- Github-Desktop -- (Report issues)
- Gitlab Ce -- (Report issues)
- Gitqlient -- (Report issues)
- Glances -- (Report issues)
- Go-Socks5-Proxy -- (Report issues)
- Gokapi -- (Report issues)
- Gotify -- (Report issues)
- Grafana -- (Report issues)
- Grav -- (Report issues)
- Grocy -- (Report issues)
- Guacamole -- (Report issues)
- Habridge -- (Report issues)
- Hasty-Paste -- (Report issues)
- Hauk -- (Report issues)
- Headphones -- (Report issues)
- Healthchecks -- (Report issues)
- Hedgedoc -- (Report issues)
- Heimdall -- (Report issues)
- Hishtory-Server -- (Report issues)
- Hoarder -- (Report issues)
- Homarr -- (Report issues)
- Homarr-Secured -- (Report issues)
- Homeassistant -- (Report issues)
- Homebridge -- (Report issues)
- Homebridge - Debian -- (Report issues)
- Homechart -- (Report issues)
- Homepage -- (Report issues)
- Homer -- (Report issues)
- Htpc Manager -- (Report issues)
- Httpd -- (Report issues)
- Huginn -- (Report issues)
- Hydra2 -- (Report issues)
- I Hate Money -- (Report issues)
- Immich -- (Report issues)
- Immich {Shmolf} -- (Report issues)
- Infisical {Shmolf} -- (Report issues)
- Influxdb -- (Report issues)
- Influxdb & Telegraf -- (Report issues)
- Influxdb 1.8.10 -- (Report issues)
- Inkscape -- (Report issues)
- Invidious -- (Report issues)
- Invoice Ninja -- (Report issues)
- Iobroker -- (Report issues)
- Iperf -- (Report issues)
- Ironfunctions -- (Report issues)
- Ironfunctions Api -- (Report issues)
- Ironfunctions Ui -- (Report issues)
- Jackett -- (Report issues)
- Jdownloader -- (Report issues)
- Jellyfin -- (Report issues)
- Jellyfin-Accounts -- (Report issues)
- Jellyseer -- (Report issues)
- Jellyseerr -- (Report issues)
- Jenkins -- (Report issues)
- Jenkins-Builder -- (Report issues)
- Joomla -- (Report issues)
- Joplin -- (Report issues)
- Jump -- (Report issues)
- Kali-Linux -- (Report issues)
- Kanzi -- (Report issues)
- Kapowarr -- (Report issues)
- Kasm -- (Report issues)
- Kavita -- (Report issues)
- Kdenlive -- (Report issues)
- Keepassxc -- (Report issues)
- Kicad -- (Report issues)
- Kimai -- (Report issues)
- Kiwix -- (Report issues)
- Klaxon -- (Report issues)
- Klipper[Testing], Mainsail, Moonraker -- (Report issues)
- Kodi Headless -- (Report issues)
- Koillection -- (Report issues)
- Kometa -- (Report issues)
- Komga -- (Report issues)
- Krita -- (Report issues)
- Lazylibrarian -- (Report issues)
- Lazytainer -- (Report issues)
- Ldap-Auth -- (Report issues)
- Leantime -- (Report issues)
- Let'S Encrypt -- (Report issues)
- Let'S Encrypt / Swag -- (Report issues)
- Libreddit -- (Report issues)
- Libreoffice -- (Report issues)
- Libresonic -- (Report issues)
- Librespeed -- (Report issues)
- Librewolf -- (Report issues)
- Lidarr -- (Report issues)
- Limnoria -- (Report issues)
- Linkstack -- (Report issues)
- Littlelink Server -- (Report issues)
- Liveswitch -- (Report issues)
- Lldap -- (Report issues)
- Logzio Logs Collector -- (Report issues)
- Logzio Metrics Collector -- (Report issues)
- Lollypop -- (Report issues)
- Lychee -- (Report issues)
- Magento 2 -- (Report issues)
- Magicmirror2 -- (Report issues)
- Mailpile -- (Report issues)
- Maloja -- (Report issues)
- Manubes Edge Node -- (Report issues)
- Manyfold -- (Report issues)
- Mariadb -- (Report issues)
- Markopolis -- (Report issues)
- Mastodon -- (Report issues)
- Matomo -- (Report issues)
- Mautic -- (Report issues)
- Mayan Edms -- (Report issues)
- Mcmyadmin 2 -- (Report issues)
- Mealie -- (Report issues)
- Medama -- (Report issues)
- Mediaelch -- (Report issues)
- Medusa -- (Report issues)
- Meilisearch -- (Report issues)
- Meshcentral -- (Report issues)
- Metube -- (Report issues)
- Microsoft Oms Agent -- (Report issues)
- Midarr -- (Report issues)
- Minecraft Server -- (Report issues)
- Minetest -- (Report issues)
- Miniflux -- (Report issues)
- Minio -- (Report issues)
- Minisatip -- (Report issues)
- Mongo -- (Report issues)
- Monica -- (Report issues)
- Moodle -- (Report issues)
- Mozilla Syncserver -- (Report issues)
- Msedge -- (Report issues)
- Mstream -- (Report issues)
- Mullvad-Browser -- (Report issues)
- Murmur -- (Report issues)
- Musicbrainz -- (Report issues)
- Muximux -- (Report issues)
- Mylar -- (Report issues)
- Mylar3 -- (Report issues)
- Mysql -- (Report issues)
- Mysql-Workbench -- (Report issues)
- N8N -- (Report issues)
- Nano -- (Report issues)
- Nano-Wallet -- (Report issues)
- Navidrome -- (Report issues)
- Neko -- (Report issues)
- Netalertx -- (Report issues)
- Netboot.Xyz -- (Report issues)
- Netbox -- (Report issues)
- Netdata -- (Report issues)
- Nextcloud -- (Report issues)
- Nextcloudstack -- (Report issues)
- Nexterm -- (Report issues)
- Nginx -- (Report issues)
- Nginx Proxy Manager -- (Report issues)
- Nginx Proxy Manager V2 With Sqlite And Goaccess Charts -- (Report issues)
- Nginx Proxy Manager V2 With Sqllite -- (Report issues)
- Nginx Proxy Manager V3 [Devel] Not Ready For Use -- (Report issues)
- Ngircd -- (Report issues)
- Nitter -- (Report issues)
- Nocodb -- (Report issues)
- Nodejs -- (Report issues)
- Nodered -- (Report issues)
- Nord-Vpn -- (Report issues)
- Nut Server -- (Report issues)
- Nuts -- (Report issues)
- Nzbget -- (Report issues)
- Nzbhydra 2 -- (Report issues)
- Obsidian -- (Report issues)
- Octoprint -- (Report issues)
- Odoo -- (Report issues)
- Omada Eap Controller -- (Report issues)
- Ombi -- (Report issues)
- Opc Router -- (Report issues)
- Openamt -- (Report issues)
- Openbudgeteer -- (Report issues)
- Openfaas -- (Report issues)
- Openssh-Server -- (Report issues)
- Openvpn Access Server -- (Report issues)
- Openvpn-As -- (Report issues)
- Openvscode-Server -- (Report issues)
- Opera -- (Report issues)
- Opnform -- (Report issues)
- Orcaslicer -- (Report issues)
- Organizr -- (Report issues)
- Organizr V2 -- (Report issues)
- Ory Kratos (Oathkeeper) -- (Report issues)
- Ory Kratos (Standalone) -- (Report issues)
- Oscam -- (Report issues)
- Outline
- Overseerr -- (Report issues)
- Owncloud -- (Report issues)
- Pairdrop -- (Report issues)
- Paperless Ngx -- (Report issues)
- Paperless-Ng -- (Report issues)
- Papermerge -- (Report issues)
- Passbolt -- (Report issues)
- Passky Client -- (Report issues)
- Passky Server -- (Report issues)
- Penpot (Http) {Shmolf} -- (Report issues)
- Petio -- (Report issues)
- Pgadmin -- (Report issues)
- Photoprism -- (Report issues)
- Photoshow -- (Report issues)
- Phpmyadmin -- (Report issues)
- Pi-Hole -- (Report issues)
- Pi-Hole Doh/Dot -- (Report issues)
- Pi-Hole-Unbound -- (Report issues)
- Pi.Alert -- (Report issues)
- Pidgin -- (Report issues)
- Pinchflat -- (Report issues)
- Pingvin -- (Report issues)
- Piper -- (Report issues)
- Piwigo -- (Report issues)
- Pixapop -- (Report issues)
- Pixel-Server -- (Report issues)
- Plane -- (Report issues)
- Planka -- (Report issues)
- Plesk -- (Report issues)
- Plex -- (Report issues)
- Plex Media Server -- (Report issues)
- Plex Requests -- (Report issues)
- Plextraktsync -- (Report issues)
- Plone -- (Report issues)
- Portainer Agent -- (Report issues)
- Poste.Io -- (Report issues)
- Postgresql -- (Report issues)
- Pritunl -- (Report issues)
- Privatebin -- (Report issues)
- Pro Mosquitto With Management Center -- (Report issues)
- Projectsend -- (Report issues)
- Protonmail Bridge -- (Report issues)
- Prowlarr -- (Report issues)
- Proxitok -- (Report issues)
- Pure-Ftp Server -- (Report issues)
- Pve-Exporter -- (Report issues)
- Pwndrop -- (Report issues)
- Pydio -- (Report issues)
- Pydio-Cells -- (Report issues)
- Pyload-Ng -- (Report issues)
- Pylon -- (Report issues)
- Python -- (Report issues)
- Qbittorrent -- (Report issues)
- Qdirstat -- (Report issues)
- Qemu-Static -- (Report issues)
- Qflood -- (Report issues)
- Quassel Irc -- (Report issues)
- Quassel-Core -- (Report issues)
- Quassel-Web -- (Report issues)
- Rabbitmq -- (Report issues)
- Radarr -- (Report issues)
- Raneto -- (Report issues)
- Raspberry Pi Docker Monitor -- (Report issues)
- Rawtherapee -- (Report issues)
- Rclone Config Backup -- (Report issues)
- Rdesktop -- (Report issues)
- Reactive-Resume -- (Report issues)
- Readarr -- (Report issues)
- Readme-Sync -- (Report issues)
- Redis -- (Report issues)
- Redis Cluster -- (Report issues)
- Redmine -- (Report issues)
- Registry -- (Report issues)
- Registry (Cache) -- (Report issues)
- Remmina -- (Report issues)
- Remotely -- (Report issues)
- Resilio Sync -- (Report issues)
- Reveal.Js -- (Report issues)
- Rocket Chat -- (Report issues)
- Rport -- (Report issues)
- Rsnapshot -- (Report issues)
- Rustdesk -- (Report issues)
- Rutorrent -- (Report issues)
- Sabnzbd -- (Report issues)
- Samba -- (Report issues)
- Scality S3 -- (Report issues)
- Scrutiny -- (Report issues)
- Searxng -- (Report issues)
- Sematext Docker Agent -- (Report issues)
- Series-Troxide -- (Report issues)
- Servas -- (Report issues)
- Shaarli -- (Report issues)
- Shiori -- (Report issues)
- Shotcut -- (Report issues)
- Sickchill -- (Report issues)
- Sickgear -- (Report issues)
- Sickrage -- (Report issues)
- Signal Proxy -- (Report issues)
- Silverstripe -- (Report issues)
- Smokeping -- (Report issues)
- Snapdrop -- (Report issues)
- Snibox -- (Report issues)
- Snipe-It -- (Report issues)
- Snippet-Box -- (Report issues)
- Socket-Proxy -- (Report issues)
- Softing Edgeconnector 840D -- (Report issues)
- Softing Edgeconnector Aggregator -- (Report issues)
- Softing Edgeconnector Fanuc Cnc -- (Report issues)
- Softing Edgeconnector Modbus -- (Report issues)
- Softing Edgeconnector Siemens -- (Report issues)
- Solr -- (Report issues)
- Sonarr -- (Report issues)
- Speedtest Tracker -- (Report issues)
- Spotube -- (Report issues)
- Sql Server -- (Report issues)
- Sql Server Express -- (Report issues)
- Sqlitebrowser -- (Report issues)
- Sshwifty -- (Report issues)
- Stash -- (Report issues)
- Statping -- (Report issues)
- Steamos -- (Report issues)
- Stirling Pdf {Shmolf} -- (Report issues)
- Stirling-Pdf -- (Report issues)
- Surrealdb -- (Report issues)
- Swag -- (Report issues)
- Swarm Monitoring -- (Report issues)
- Synclounge -- (Report issues)
- Syncthing -- (Report issues)
- Syslog-Ng -- (Report issues)
- System Stats Oled Display -- (Report issues)
- Tabby -- (Report issues)
- Tailscale -- (Report issues)
- Tandoor -- (Report issues)
- Tautulli -- (Report issues)
- Tdarr -- (Report issues)
- Teleport -- (Report issues)
- Terraria Server {Shmolf} -- (Report issues)
- Tester -- (Report issues)
- Thelounge -- (Report issues)
- Tiddlywiki -- (Report issues)
- Timetagger -- (Report issues)
- Tiny Tiny Rss -- (Report issues)
- Tinymediamanager -- (Report issues)
- Tooljet -- (Report issues)
- Tosibox Lock For Container -- (Report issues)
- Traefik -- (Report issues)
- Traggo -- (Report issues)
- Transmission -- (Report issues)
- Transmission Openvpn Latest -- (Report issues)
- Transmission Openvpn V3 -- (Report issues)
- Transmission-Openvpn -- (Report issues)
- Trilium -- (Report issues)
- Trudesk -- (Report issues)
- Tubearchivist -- (Report issues)
- Tvheadend -- (Report issues)
- Twitch Points Miner -- (Report issues)
- Ubooquity -- (Report issues)
- Ubuntu -- (Report issues)
- Umami.Is -- (Report issues)
- Ungoogled-Chromium -- (Report issues)
- Unifi Controller -- (Report issues)
- Unifi Video -- (Report issues)
- Unifi-Network-Application -- (Report issues)
- Unmanic -- (Report issues)
- Unrar -- (Report issues)
- Upsnap -- (Report issues)
- Uptime Kuma -- (Report issues)
- Urbackup -- (Report issues)
- Urlwatch -- (Report issues)
- Vaultwarden -- (Report issues)
- Vikunja -- (Report issues)
- Vlmcsd - Kms -- (Report issues)
- Vscodium -- (Report issues)
- Vsftpd Ftp Server -- (Report issues)
- Wallabag -- (Report issues)
- Watchtower -- (Report issues)
- Watchtower {Shmolf} -- (Report issues)
- Web Check -- (Report issues)
- Webcord -- (Report issues)
- Webgrab+Plus -- (Report issues)
- Webtop -- (Report issues)
- Webtrees -- (Report issues)
- Wger -- (Report issues)
- Whisparr -- (Report issues)
- Whoogle -- (Report issues)
- Wikijs -- (Report issues)
- Wireguard -- (Report issues)
- Wireguard Server -- (Report issues)
- Wireshark -- (Report issues)
- Wizarr -- (Report issues)
- Wordpress -- (Report issues)
- Wowza -- (Report issues)
- Wps-Office -- (Report issues)
- Xbackbone -- (Report issues)
- Xwiki -- (Report issues)
- Yaak -- (Report issues)
- Yacht -- (Report issues)
- Your_Spotify -- (Report issues)
- Youtubedl-Material -- (Report issues)
- Yq -- (Report issues)
- Znc -- (Report issues)
- Zotero -- (Report issues)
- Zus.Am -- (Report issues)
↕️ 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.
- template by @dnburgess
- template by @Qballjos
- template by @SelfhostedPro
- template by @technorabilia
- template by @mikestraney
- template by @xneo1
- template by @novaspirit
- template by @donpablonow
- template by @mediadepot
- template by @mycroftwilde
- template by @mediadepot
- template by @shmolf
- template by @portainer
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.
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.
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.
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
Alicia Bot |
Alicia Sykes |
Nicholas Browning |
Benjamin Ranson |
Gilbert Palau |
Kartik Rao |
Lee Trout |
Pierre Balzack |
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 :)