portainer/templates

App Templates used by Portainer

App Templates

This repository hosts the official templates ('Apps Templates') definitions for Portainer.

For more information about the template definition format and how to deploy your own templates, see the relevant documentation section.

Notice

This branch (master) is Deprecated.

Since version 3 of the templates, we've moved to use v3 branch as the default branch for this repository. If you are using version 2, please use the master branch of this repository (or https://raw.githubusercontent.com/portainer/templates/master/templates-2.0.json).

templates's Issues

Plone template

Add a template for Plone: https://hub.docker.com/_/plone/

Enhance templates variables definition

I would like to be able to add env variables not only with input fields, but with more types.
We develop an internal tool for this purpose, and we could abandon it for portainer if we have this feature.
I'll try to describe it with examples :

Today we have a mysql template, like that :

{
    "title": "MySQL",
    "description": "The most popular open-source database",
    "categories": ["database"],
    "platform": "linux",
    "logo": "https://cloudinovasi.id/assets/img/logos/mysql.png",
    "image": "mysql:latest",
    "env": [
      {
        "name": "MYSQL_ROOT_PASSWORD",
        "label": "Root password"
      }
    ],
    "ports": [
      "3306/tcp"
    ],
    "volumes": ["/var/lib/mysql"]
  }

I imagine something like that :

{
    "title": "MySQL",
    "description": "The most popular open-source database",
    "categories": ["database"],
    "platform": "linux",
    "logo": "https://cloudinovasi.id/assets/img/logos/mysql.png",
    "image": "mysql:latest",
    "env": [
      {
        "name": "MYSQL_ROOT_PASSWORD",
        "label": "Root password"
      },
      {
        "name": "MYSQL_VAR_1",
        "label": "var 1",
        "type": "select",
         "values": [
           "value1",
           "value2"
         ]
      },
      {
        "name": "MYSQL_VAR_2",
        "label": "var 2",
        "type": "select",
         "values_from": "https://mywebservice/mysql/var2"
      },
      {
        "name": "MYSQL_VAR_3",
        "label": "var 3",
        "type": "radio",
         "values": [
           "value1",
           "value2"
         ]
      }
    ],
    "ports": [
      "3306/tcp"
    ],
    "volumes": ["/var/lib/mysql"]
  }

This will generate form according to json description
We already do that here to deploy stacks from compose templates, with var values comming from other webservices, and it's powerful

This can be added for container templates as well as for WIP stack templates

Thanx

Template - Debian

Template - MongoDB

Template - Redis

Template - Ubuntu

Seafile docker

Create a template to use this Docker image: https://github.com/haiwen/seafile-docker#getting-started

Add a consul template

Image: https://hub.docker.com/_/consul/

Template - Registry

Add a template for the registry image.

Bind port 5000.

traefik template

how about add traefik template?

Glusterfs

Hi

I would suggest a new template that will add a glusterfs HA distributed storage volume system.

That coupled with the swarm mode will create a seriously HA infrastructure since data/volumes will be HA as well.

Zimbra template

Add a zimbra template based on the following image: https://hub.docker.com/r/zextras/zimbra8

Add a JSON validation to validate each PR

When a PR is created, it should trigger a hook on some CI instance to execute a JSON validation against the templates.json file.

Template testing

Hi,

I've got a problem to use templates from github:

docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock --name p1 \
portainer/portainer  --no-auth --templates https://raw.githubusercontent.com/megastef/templates/master/templates.json
05b831e278d0980c4832e77f32f9c01ee020569fc066b906f803fc8ff8d5464b
imac:templates stefan$ docker logs p1
2017/03/14 08:39:31 Migrating database from version 0 to 1.
2017/03/14 08:39:31 Starting Portainer on :9000
2017/03/14 08:39:37 http error: Endpoint not found (code=500)
2017/03/14 08:39:37 http error: Endpoint not found (code=500)
2017/03/14 08:39:37 http error: Endpoint not found (code=500)

When I click to App templates I get an error message in the UI.

The fun part: using the github URL from this repository works fine, without any error:

docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock --name p1  \
portainer/portainer  --no-auth --templates https://raw.githubusercontent.com/portainer/templates/master/templates.json
15d8f1d63f74070157c587533d38f64e7bc54ccdec6f8657694656e40884070e
imac:templates stefan$ docker logs p1
2017/03/14 08:46:35 Migrating database from version 0 to 1.
2017/03/14 08:46:35 Starting Portainer on :9000
imac:templates stefan$ docker logs p1
2017/03/14 08:46:35 Migrating database from version 0 to 1.
2017/03/14 08:46:35 Starting Portainer on :9000

My URL works, and it is valid json ...
https://raw.githubusercontent.com/megastef/templates/master/templates.json

Could you please tell me what could be wrong?

Add Readme field to templates

It would be nice to show a readme as documentation for templates.
The templates could contain at least a readme field supporting markdown format.
This would help to give user instructions or point to full documentation of the application.

Template - Wowza

Based on:

docker run --name wowza -d --restart=always --publish 1935:1935 --publish 8086:8086 --publish 8087:8087 --publish 8088:8088 --env "WOWZA_ACCEPT_LICENSE=yes" --env "WOWZA_KEY=MYWOWZAKEY sameersbn/wowza:4.1.2-8

Rocket chat template

Create a template for the following tool: https://hub.docker.com/r/rocketchat/rocket.chat/

Template - Elasticsearch

Template - HAProxy

Template category

Each template should define a category (database, web server, developer tool...) so they could be sorted in the Portainer UI.

multiple architecture support

Support templates that properly handle portainer running on architectures other than amd64.

I'm not sure how this actually gets implemented in the future. In practice, if you are on a linux/arm64 machine, portainer presents you with linux/amd64 images as templates that won't run.

One possibility is another field in the template definition that describes the architectures it runs on; the bigger future is for widespread use of multiarch containers and some run-time check to validate for each container which architecture it is built for.

MSSQL for windows

There is no such thing as microsoft/mssql-server-windows:latest, only express and developer

https://hub.docker.com/r/microsoft/

Fluentd template

Add a fluentd template: https://hub.docker.com/r/fluent/fluentd/

Support foreground flags (i.e. -i -t) in portainer templates

Feature Request: support foreground flags, i.e. (-i -t), in portainer templates

Reference: This feature request is in reference to the screencast I just shared with you showing how foreground flag support is necessary in order to use a custom Portainer template to open a [python, etc] container (and keep it open).

Link to screencast: https://portainer.slack.com/files/forman/F53M0TW03/portainer-screencase.mov

BTW: love this software product (portainer) !

Thanks,

James

Add the ability to specify registry

Users should be able to create templates for images hosted in any private registries.

Onlyoffice community server template

See the documentation here: http://helpcenter.onlyoffice.com/server/docker/community/docker-installation.aspx?_ga=2.118660553.1593764273.1495826388-447960244.1495826314

Netsil template

Image: netsil/netsil

There should be a client and a server template. We must be able to deploy the agent as a Swarm service, this will have to wait until Swarm service templates support is added into Portainer.

Urbackup template

Image: cfstras/urbackup/

CockroachDB template

Add a template to easily deploy CockroachDB.

Document the type field for an environment variable

The type field is not documented at http://portainer.readthedocs.io/en/stable/templates.html

 {
    "title": "WordPress",
    "description": "A free and open-source CMS",
    "logo": "https://cloudinovasi.id/assets/img/logos/wordpress.png",
    "image": "wordpress:latest",
    "env": [
      {
        "name": "WORDPRESS_DB_HOST",
        "label": "MySQL database host",
        "type": "container"
      },
      {
        "name": "WORDPRESS_DB_PASSWORD",
        "label": "Database password"
      }
    ],
    "ports": [
      "80/tcp"
    ]
  }

Template - Httpd

Point the documentation at RTD

Remove the docs from the README and point at portainer.readthedocs.io/en/stable/templates.html

Template - Joomla

Add a Joomla template: https://hub.docker.com/_/joomla/

Add missing volume declarations

I just noticed that portainer was not showing any linked volumes for some of my containers and with the help of @ncresswell I was able to find that it just created a non persistent volume (the one auto generated by docker) and not a persistent one.
It is probably a good idea to add the volumes to some templates (I only played with wordpress, nginx and apache) as a user will most likely not expect that the volume gets deleted when the container gets deleted.

Add an etcd template

Image: https://hub.docker.com/r/elcolio/etcd/

Host template logos

We should host the logos somewhere.

In this repository could be a good start. Also, rework the logo so they're the lightest possible, to enhance download speed.

Template - Magento2

Based on:

docker run -d -i -t -p 9080:80 -p 3000:3000 -p 3001:3001 -p 2222:22 --name gsd alankent/gsd

LinuxServer.io template contributions

Hi,

I'm one of the LinuxServer.io guys, we make 'a few' Docker containers here. We maintain a bunch of templates for native integration into unRAID and OpenMediaVault already. I've been using your UI for a couple of weeks and really like it.

We'd like to know if you're interested in starting a partnership to include our templates in your UI out of the box?

Regards.
IB

Template - Jenkins

Compose utility

Its possible to use compose to define multiple services?

Drupal 7 template

Minio template

Add a template for https://hub.docker.com/r/minio/minio/

Move to portainer org

Move to the portainer organization and rename as portainer-templates.

Template - Drupal

Networking field in template.json

Please could you add in a "networking" field into the template.json so that we can pre-define a docker for either bridge or net use?

Thanks

Pass a command to a template

A template should be able to define command line arguments to be executed when deploying the container.

How to pass docker socket as volume?

Hi,

the volume entry in the template is a simple array. How could i pass
-v /var/run/docker.sock:/var/run/docker.sock?

I'm working on a template entry and access to docker socket is mandatory for it, see: https://gist.github.com/megastef/0a97da2cecd619e643edf2a1307c6fb4

Ahh, one more question - is there an option to run a global Swarm service via template?

Thx
Stefan

microsoft/mssql-server-linux:latest is outdated

MS decided to remove the :latest-tag:
https://hub.docker.com/r/microsoft/mssql-server-linux/

Please update the template to use tag :2017-GA

Thank you!

Template - Node

Template definition parity with container creation

One user asked for "Template feature parity with create container ui" via portainer/portainer#564

This implies to add all the available configuration for a container creation.