portainer-templates

<h1 align="center">Portainer Templates</h1> A compiled list of 500+ ready to go Portainer App templates <a href="https://portainer-templates.as93.net"> 🌐 portainer-templates.as93.net <img width="200" src="https://i.ibb.co/hMymwH0/portainer-templates-small.png" /> </a>

TL;DR Under Settings → App Templates in your Portainer GUI, paste this URL: https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

<details> <summary>Contents</summary>

Intro
Usage
Self-Hosting
Editing
Included Apps
Sources
Raising Issues
Contributing
Website
Mirror
Credits
License

</details>

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 <ins>Settings</ins> --> <ins>App Templates</ins>, update the URL to
- https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Now under <ins>Home</ins> --> <ins>App Templates</ins>, 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.

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.

<details> <summary><h2>Supported Apps and Stacks</h2> ↕️ Click to Expand ↕️</summary>

Click an item, to see stats, config options and installation instructions

<img title="Automate your marketing sales and operations" src='https://cdn.activepieces.com/brand/full-logo-white.svg' width='26' height='26' /> Activepieces -- (Report issues)
<img title="Actual is a super fast privacy focused app for managing your finances "