Portainer Documentation
Official WebsiteGet 5 Nodes of BE Free
Search…
BE 2.7
Welcome
Release Notes
Getting Started
Introduction
Portainer architecture
Requirements and prerequisites
Install Portainer BE
Upgrading Portainer
Using Portainer
Docker/Swarm
Dashboard
App Templates
Custom templates
Deploy a stack
Deploy a container
Stacks
Services
Containers
Images
Networks
Volumes
Configs
Secrets
Events
Host
Swarm
Kubernetes
Azure ACI
Edge Compute
Administering Portainer
Users
Endpoints
Registries
Licenses
Authentication logs
Settings
Frequently Asked Questions
Portainer Concepts
Installing
Upgrading
Troubleshooting
Contributing
Advanced Topics
CLI configuration options
App templates
The Portainer Edge Agent
Access control
Reset the admin user's password
Security and compliance
Using SSL with Portainer
Using Portainer with reverse proxies
Helm chart configuration options
Kubernetes roles and bindings
Deprecated and removed features
API
API documentation
API usage examples
Get More Help
YouTube
Open a support request
Contribute to Portainer
Contribute
Powered By GitBook
Custom templates
A custom template can be used to help streamline the deployment of a container or stack.

Viewing the list of custom templates

To view a list of custom templates, from the menu select App Templates then select Custom Templates.

Creating a new custom template

Entering the basic information

Click Add Custom Template then complete the details, using the table below as a guide.
Field/Option
Overview
Title
Give the template a descriptive name.
Description
Enter a brief description of what your template includes.
Note
Note any extra information about the template (optional).
Icon URL
Enter the URL to an icon to be used for the template when it appears in the list (optional).
Platform
Select the compatible platform for the template. Options are Linux or Windows.
Type
Select the type of template. Options are Standalone or Swarm.

Selecting the build method

Next, choose the build method that suits your needs. You can use the web editor to manually enter your docker-compose file, upload a docker-compose.yml file from your local computer, or pull the compose file from a Git repository.

Web editor

Paste the contents of your docker-compose file into the box provided. Once all the details have been completed, click Create custom template.
Using the Web editor

Upload

Click Select file to browse for a docker-compose file to upload. Once all the details have been completed, click Create custom template.
Using the Upload method

Git repository

Fill in the details for your Git repository.
Field/Option
Overview
Repository URL
Enter the URL to your Git repository.
Repository reference
Enter the repository reference to define the branch or tag to pull from. If blank, the default HEAD reference will be used.
Compose path
Enter the path within the repository to your docker-compose file.
Configuring a Git repository
If your repository requires access authentication, toggle Authentication on then enter the username and password. When all the details have been entered, click Create custom template.
Previous
App Templates
Next
Deploy a stack
Last modified 2mo ago
Copy link
Edit on GitHub
Contents
Viewing the list of custom templates
Creating a new custom template
Entering the basic information
Selecting the build method