Portainer Documentation
Official WebsiteGet 5 Nodes of BE Free
Search…
2.14
Welcome
What's new in version 2.14
Release Notes
Getting Started
Introduction
Portainer architecture
Requirements and prerequisites
Install Portainer
Upgrading Portainer
Using Portainer
Home
Docker/Swarm
Kubernetes
Azure ACI
Nomad
Edge Compute
Account settings
Administering Portainer
Users
Environments
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
Encrypting the Portainer database
Using your own SSL certificate with Portainer
Using Portainer with reverse proxies
Helm chart configuration options
Kubernetes roles and bindings
Deprecated and removed features
API
Accessing the Portainer API
API documentation
API usage examples
Get More Help
YouTube
Slack
Discord
Open a support request
Contribute to Portainer
Contribute
Build instructions
Powered By GitBook
Release Notes
The following release notes are for the Business Edition of Portainer. For Community Edition release notes, refer to the GitHub releases page.

Release 2.14.2

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.
  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.

Kubernetes

  • Fixed an issue where the kubeconfig downloadable from Portainer always had port 9443 in its URLs, even though the actual Portainer instance was being accessed via another port. portainer/portainer#7059​

Docker

  • Fixed certificate file validation for .pem files portainer/portainer#7183​
  • Fixed an issue when using a Mustache variable (e.g. {{service}}) multiple times in the YAML, where the UI should prompt for it only once and then reuse it (rather than prompting for it multiple times).
  • Fixed an issue when using a Mustache variable (e.g. {{path}}) with special characters in the value, where the resulting value would end up being HTML encoded.
  • Fixed issue around access control labels being ignored.

Portainer

  • Fixed an issue where the original admin user was unable to change their password when external authentication is enabled. portainer/portainer#7291​
  • Fixed toggle state reset issue for custom logo and anonymous statistics. portainer/portainer#7278​
  • Fixed issue with not being able to add users to teams while LDAP authentication is enabled without auto teams population. portainer/portainer#7252​
  • Fixed an issue where auto populate team admins LDAP feature didn't work on upgrade from CE to BE.
  • Resolved an issue where new installs of recent Portainer releases had an extraneous (although innocuous) db version update on restart.

Edge

Release 2.14.1

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.
  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.
  • When using a Mustache variable (e.g. {{ service }}) multiple times in the YAML, the UI also prompts for it multiple times, rather than prompting for it a single time and then reusing it.

Kubernetes

  • Improved KaaS cluster provisioning's cluster name validation to enforce restrictions that Google GKE expects.
  • Fixed issue of variable inputs not showing on deployment view when using custom templates.
  • Improved Portainer logging to better record the output from eksctl, the CLI tool used for Amazon EKS (KaaS) cluster provisioning.
  • Fixed an issue where, upon initiating AWS KaaS cluster/environment provisioning and subsequently restarting Portainer in a short space of time, the requested environment would become stuck and unusable in Portainer, and couldn't be deleted.

Docker

  • Resolved an issue where users running Portainer with non-root access were receiving a 'Permission denied on docker-compose' error since the recent update to Docker Compose V2. portainer/portainer#6906​

Portainer

  • Fix to improve LDAP, etc. authentication/login speed when there are many thousands of users.
  • Resolved an issue where users upgrading a Portainer install, where the portainer_data volume is stored on a network volume, receive a 'Permission denied' error when the upgrade attempts a backup of the database. portainer/portainer#7144​
  • Fixed "Create user" button in disabled stage when external Auth enabled. portainer/portainer#7214​

Edge

  • Fixed issue where the edge agent could not connect when running Portainer behind a reverse proxy only supporting TLS v1.2. portainer/portainer#7167​

Release 2.14.0

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.
  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.

Breaking changes

  • With the upgrade to Docker Compose V2, container names now use hyphens as separators instead of underscores. This may affect you if you are generating container names instead of explicitly defining them, then using them as references.

Kubernetes

  • Introduced ability to set up a new Kubernetes environment in Portainer via upload of a kubeconfig file for an existing on premises or on-cloud cluster.
  • Fixed issue around Git clone working with Main (in addition to existing Master) branch type. portainer/portainer#6002​
  • Updated packaged components to recent stable release versions: Docker 20.10.9, Docker Compose plugin 2.5.1, kubectl 1.24.1, Helm 3.9.0. portainer/portainer#6074​
  • Administrators can now set up cloud provider settings via a list page and separate add page in a similar way to other records in Portainer.
  • Introduced support for provisioning of a Kubernetes cluster on the Amazon (AWS) EKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal. The AWS eksctl binary is auto downloaded when first using this functionality.
  • Introduced support for provisioning of a Kubernetes cluster on the Microsoft Azure AKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal.
  • Introduced support for provisioning of a Kubernetes cluster on the Google Cloud GKE platform from within Portainer, alleviating the need to do so in the cloud provider's portal.
  • Fixed a typo in the Kubernetes -> Namespaces -> Create from manifest (advanced deployment) page. portainer/portainer#6968​
  • Fixed an issue with cluster provisioning via Civo KaaS, where if the Civo account has an issue with its defined networks, the environment was stuck waiting to complete provisioning and never ultimately errored.
  • Introduced the ability to set the group and tags against the environment in Portainer when an admin provisions a Kubernetes as a Service cluster.
  • Introduced slight improvements to editing of sensitive cloud credentials values.
  • Fixed an issue in the Settings -> Environments page, where an environment that was disabled or still being provisioned could be selected for removal and then removed.
  • Added the ability to manually refresh pulling of Kubernetes as a Service cluster provisioning options from cloud providers.
  • Improved error handling around KaaS provisioning in the environment wizard.
  • Kubernetes as a Service (cloud) provisioned environments will now appear in the 'new environments' side panel in the environments wizard.

Docker

  • Introduced a visual indication of stacks, services and containers that are running with an out-of-date image. portainer/portainer#1304​
  • Fixed issue around Git clone working with Main (in addition to existing Master) branch type. portainer/portainer#6002​
  • Updated packaged components to recent stable release versions: Docker 20.10.9, Docker Compose plugin 2.5.1, kubectl 1.24.1, Helm 3.9.0. portainer/portainer#6074​
  • Fixed issue for standard user having an empty network as default when creating containers on Windows environments portainer/portainer#6959​
  • Introduced ability to pass environment variables on the webhooks in Docker stack deployment.
  • Provide a stack template for dokku deployment within portainer. portainer/portainer#7011​
  • Resolved an issue when updating an application and changing its service from replicated to global, where an error occurs and the deployed application is deleted. portainer/portainer#7056​
  • Third-party developer Inedo has fixed their ProGet registry software to resolve an intermittent error admins were experiencing in Portainer on retag or delete of a tagged image. This is planned to ship 10 June 2022 in ProGet 6.0.16, before Portainer 2.14.
  • Introduced support in the container webhook for pull/recreate of containers from images residing in private registries.
  • Fixed an issue in the Containers page, where choosing 'Recreate' enabled the webhook for the container, even though it was not currently turned on.
  • Fixed an issue where, when calling Swarm update API through Portainer, incorrect overriding of the registry authentication header occurred, preventing pull of an image. portainer/portainer#7095​

Portainer

  • Redesigned team leader feature. portainer/portainer#7093​
  • Fixed an issue where the delete environment confirmation dialog was positioned too low on-screen. portainer/portainer#6983​
  • Fixed an issue where agent and edge agent install command instructions do not list the agent_secret option. portainer/portainer#6801​
  • Fixed an issue where the home (environments) page no longer showed the words 'No tags' for environments without tags. portainer/portainer#6967​
  • Introduced support for provisioning of a Kubernetes cluster on the Amazon (AWS) EKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal. The AWS eksctl binary is auto downloaded when first using this functionality.
  • The Add environment page and Environment wizard are now consolidated into a single consistent, improved wizard-style experience. portainer/portainer#7022​
  • Introduced support for provisioning of a Kubernetes cluster on the Microsoft Azure AKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal.
  • Introduced support for provisioning of a Kubernetes cluster on the Google Cloud GKE platform from within Portainer, alleviating the need to do so in the cloud provider's portal.
  • Fixed Go panic state for the environments list handler portainer/portainer#7047​
  • Introduced ability for admin to set required password length. portainer/portainer#7055​
  • Fixed an issue recently introduced in the environments page where the name of an environment that was down no longer linked through to its details page.
  • Resolved an issue preventing migration from EE 2.12 to 2.13 (or now 2.14) for Portainer instances that had previously migrated to EE from a CE instance with Allow Volume Browser for Regular Users toggled on for an environment.
  • Increased the click/touch area in expandable panels so it's easier to open/close them. portainer/portainer#7036​
  • Fixed propagation of Portainer agent polling frequency when changed before deploying via automatic edge environment creation
  • Introduced the ability to paste in an existing license, revalidate with the license server and replace it in the database. This can be used to fix a corrupted license.

Edge

  • Fixed issue with status indicator on Edge Stacks not updating when removing tags from edge environments/groups portainer/portainer#6950​
  • Introduced the ability to define the 3 polling intervals for Async
  • For edge agents, the URL shown in the Environment summary page (access from the Home page) has now been removed, as it caused confusion since it simply showed the Portainer Server URL. portainer/portainer#6978​
  • Fixed Data race in the operations of the edge key in the Edge Agent portainer/portainer#7024​
  • Added "goto page" to the Edge devices page view portainer/portainer#6982​
  • Added the ability to add edge agents in the environment wizard portainer/portainer#7023​

Nomad

  • Added HTTPS support for Nomad Edge Agent.
  • Added display of BE feature highlights in CE for new Nomad, KaaS provisioning and kubeconfig import functionality. portainer/portainer#7051​

Release 2.13.1

Portainer

Release 2.13

Known issues

  • When provisioning a Civo cluster while there are multiple default networks defined on the Civo account, the environment will fail to provision and Portainer will end up waiting for the environment to be ready indefinitely. This can be resolved from the Civo console by deleting the cluster and using a non-default network for the provision.

Breaking changes

  • The minimum TLS version of Portainer was changed from 1.2 to 1.3. If you are running a proxy in front of Portainer with HTTPS you will need to ensure it is configured to support TLS 1.3.
  • Standard users can browse registries including edit and delete
  • Introduced the ability for non admin users to browse image registries
  • Added strong password policy for all Portainer internal users. When using a weak password and logging in you will be required to update your password.

Kubernetes

  • Improve how Portainer helps you set up ingresses (especially Nginx ones), including support of regular expressions in paths - by assisting with required annotations and correcting a rewrite issue: portainer/portainer#6854​
  • Introduce support for provisioning of a Kubernetes cluster on a cloud provider's KaaS offering from within Portainer, alleviating the need to do so in the provider's own portal. Initial supported providers are Civo, DigitalOcean and Linode.
  • Fixed an issue where, on setting up (on a namespace) an ingress controller for a k8s cluster and I create an app with two ingress routes on the controller, app details show only the second of the paths: portainer/portainer#6856​
  • Fixed an issue where Portainer's validation of a K8s namespace's hostnames was disallowing wildcards (e.g. *abc.com): portainer/portainer#6855​
  • Fixed issue with default helm repo not populating in settings page: portainer/portainer#6849​
  • Created documentation around using GKE ingress with Portainer: portainer/portainer#6848​
  • Added input validation for kubernetes workload names: portainer/portainer#5363​
  • Fixed issue where changing Portainer to HTTPS crashed Portainer: portainer/portainer#6836
  • Fixed issue where Helm Charts could not be deployed when using SSL certs with Portainer: portainer/portainer#6742​
  • Fixed issue of not being able to use a name previously used for kubernetes resources: portainer/portainer#6830​
  • Fixed issue where the Kube cluster resource stats had a rounding issue: portainer/portainer#6472​
  • Fixed an issue when deploying Portainer client with AGENT_SECRET without configuring Kubernetes agent with AGENT_SECRET where an "Failure unknown" error shows rather than "agent already paired" : portainer/portainer#6791​

Docker

  • Standard users can browse registries including edit and delete
  • Introduced the ability for non admin users to browse image registries
  • Fixed issue where the Disable bind mounts for non-administrators setting would prevent existing volumes from being used: portainer/portainer#6387​
  • Fixed issue with creating a CIFS volume that uses a hostname: portainer/portainer#6338​
  • Fixed issue where webhooks for services were accepting invalid tags: portainer/portainer#6493​
  • Fixed issue with libcompose logging where error output is attempted to be included when an error did not occur: portainer/portainer#6857​
  • Fixed an issue where 'Pull and Redeploy' and 'Force redeploy' don't work on ARM: portainer/portainer#6788​
  • Documented deviation from the Docker standard when using the /docker/images/create API endpoint in conjunction with a private registry: portainer/portainer#6712​
  • Fixed issue where credentials from different registries were being used: portainer/portainer#6087​
  • Fixed issue where stack name was stated inaccurately in the message which informs users that a container/service inherited its access control settings from a specific stack: portainer/portainer#6478​
  • Fixed issue with displaying container template when connected to docker swarm in the app templates page view: portainer/portainer#6837​
  • Fixed text color on modal when updating a service: portainer/portainer#6839​
  • Fixed issue where Watchtower did not work for standalone stacks on Arm64: portainer/portainer#5799​

Portainer

  • Enforced strong password policy for all Portainer Users: portainer/portainer#6846​
  • Improved the database migration to become more resilient: portainer/portainer#6778​
  • Introduced the ability to filter and sort environments on the Home page: portainer/portainer#6823​
  • When changing the user password the user gets redirected to the login page: portainer/portainer#6456​
  • Fixed issue where upgrading to the Business Edition and then downgrading back to the Community Edition did not work
  • Improved security for custom templates when using Git repos that contain symlinks: portainer/portainer#6847​
  • Improved how the installation page times out: portainer/portainer#6740​
  • Improved file type validation when selecting multiple files when deploying from Git repository
  • Removed superfluous warning message for the Enable Change Window setting
  • Fixed bug relating to environment status in home page: portainer/portainer#6047​
  • Improved concurrency in agent code to prevent race conditions: portainer/portainer#6677​
  • Improved concurrency in backend code to prevent race conditions: portainer/portainer#6677​
  • Fixed duplicate naming issue for registries: portainer/portainer#6838​
  • Fixed issue around user accessing agent environment after changing an invalid environment url to a valid one: portainer/portainer#6824​
  • Fixed issue with the menu when connecting to another environment fails: portainer/portainer#6449​
  • Updated registry form wording from Password to "Dockerhub access token" : portainer/portainer#6308​
  • Fixed text color for change window warning text
  • Fixed an issue where the hover-over tooltip for nav menu items always just showed 'Settings' rather than the menu item text: portainer/portainer#6779​
  • Fixed issue where the green success notification was not showing up after deleting a custom app template: portainer/portainer#6724​
  • Improved UX for setting themes by removing save button: portainer/portainer#6840​

Edge

  • Renamed Trust on first connect to "Waiting Room"
  • Introduced the ability to pass env variables from local system to edge stacks for Kubernetes environments
  • Created the ability for Automatic Edge Environment Creation (AEEC) within Portainer Server
  • Introduced support for using credentials with private registries for edge stacks
  • Resolved data race on stack deploy for edge agents: portainer/portainer#6677​
  • Added environment variable to the agent to adjust the probe timeout and interval: portainer/agent#293​
  • Introduce the ability to pass env variables from a local system on edge devices to the edge stack: portainer/portainer#6832​
  • Fixed issue with edge environments having faulty heartbeat on Edge Devices page: portainer/portainer#6825​
  • Improved concurrency in edge code to prevent race conditions: portainer/portainer#6677​
  • Fixed data race in poll service on Edge Agent: portainer/portainer#6677​
  • Resolved some race conditions with the edge agent: portainer/portainer#6677​
  • Resolved data race on tunnels for edge agents: portainer/portainer#6677​
  • Resolved data race with activity timer for edge agents: portainer/portainer#6677​
  • Fixed issue with displaying AMT device table for non-activated devices: portainer/portainer#6835​
  • Fixed minor UI issues in Edge devices page view around Action buttons: portainer/portainer#6844​
  • Fixed issue when creating edge job from file returning 404: portainer/portainer#6826​

Development

Release 2.12.2

Nomad

  • Introduced Nomad integration
  • Allows Nomad to be added as an environment in Portainer by using the Edge Agent
  • Allows Edge Stacks to be deployed on Nomad as Nomad Jobs
  • Allows Nomad Jobs and Tasks to be listed
  • Allows Nomad logs and events to be viewed for Tasks

Kubernetes

  • Fixed issue where changing Portainer to HTTPS crashed Portainer
  • Fixed issue around deploying in default namespace via manifest using the portainer namespace instead
  • Fixed bug causing domain names to not displaying correctly under publish application options
  • Fixed issue with first service naming having a suffix attached.
  • Improved error message being displayed when deploying a malformed Kubernetes manifest from GitOps

Portainer

  • Fixed issue with GitOps automatic update
  • Fixed issues around migration path for CE to BE
  • Fixed missing operator role when migrating from 1.x
  • Improved concurrency in edge code to prevent race conditions: portainer/portainer#6677​

Edge

  • Resolved some race conditions with the Edge Agent

Release 2.12.1

Portainer

  • Fixed bug where redeploying a stack causes an error and success message at the same time.
  • Fixed bug that was preventing ability to edit application with persisted folder on Kubernetes.

Release 2.12.0

Breaking changes

  • When OAuth is enabled, Portainer users can no longer use their Portainer internal password: portainer/portainer#5889​
  • Deploying a manifest without a namespace definition and selecting the Default namespace in Portainer may deploy the application into the portainer namespace in certain circumstances

Kubernetes

Docker

Portainer

Edge

  • Introduce the ability to pass env variables from a local system on edge devices to the edge stack
  • Fixed minor UI behavior with toggles in Edge Compute settings view
  • Fixed issue with displaying AMT device table for non-activated devices
  • Fixed minor UI issues in Edge devices page view around Action buttons
  • Introduced the ability to control and interact with OpenAMT: devices portainer/portainer#6444​
  • Introduce the ability to add edge devices through FDO: portainer/portainer#6445​
  • Added behavior for Edge agents to reject connections if not connected to within 72hrs: portainer/portainer#6420​
  • Optimize disk performance for Edge Agent portainer/portainer#6455​
  • Fixed issues with the Edge Agent reverse tunnel timing out: portainer/portainer#5725​
  • Fixed issue where the URL of an Environment would change to localhost: portainer/portainer#5803​

Registry

ACI

  • Fixed issue where ACI stopped working when the number of exposed ports and container ports were different: portainer/portainer#5335​

Development

Release 2.10.0

Known issues

  • Both Portainer and the Agent need to be upgraded at the same time: portainer/agent#187​
  • Restarting Portainer will invalidate all downloaded Kubeconfig files: portainer/portainer#5574​
  • Access can not be assigned to registries when defining multiple registries with the same URL
  • Browser cache causes UI abnormalities after upgrading from a prior version. Force a cache refresh (Ctrl-Shift-R) to remedy

Breaking changes

  • Default HTTPS support has been added: portainer/portainer#5462​
    As a consequence the --ssl flag has been deprecated. If you are using the --sslcert and --sslkey flags, then after the upgrade port 9000 will serve http and port 9443 will serve https with the provided certificate. To retain the old behavior consider using the port mapping -p 9000:9443 instead.
  • The /stacks API has renamed from ComposeFilePathInRepository to ComposeFile, and the non-mandatory fields AdditionalFiles and AutoUpdate were added: portainer/portainer#5461​

Security

  • It is advisable to upgrade to this version, since some security improvements have been made with regards to embedding images: portainer/portainer#5805​

Kubernetes

Docker

Portainer

  • Added automatic updates of stacks and applications to the activity logs
  • Introduced the ability to define a time based change window in which automatic updates of stacks and applications can take place
  • Introduced the ability to automatically set OAuth users as a Portainer Admin
  • Introduced the ability to automatically set LDAP users as a Portainer Admin
  • Added a Portainer and Agent Juju Charm to the Charmhub marketplace
  • Introduced dark theme and high contrast mode: portainer/portainer#5493​
  • Introduced the ability to access Portainer via HTTPS: portainer/portainer#5462​
  • Renamed Endpoints to Environments in the UI: portainer/portainer#5492​
  • Improved the menu UI to indicate the existence of sub items: portainer/portainer#5528​
  • Improved UI how to add environments to Portainer when doing a new installation: portainer/portainer#5477​
  • Added functionality to copy error messages from toast notifications: portainer/portainer#5720​
  • Improved how a Portainer upgrade can be rolled back: portainer/portainer#5482​
  • Improved UI where the table background wasn't working very well in dark mode: portainer/portainer#5714​
  • Fixed issue where Git content could not be cloned when Portainer is behind a proxy: portainer/portainer#3286​
  • Fixed issue where the SSL certificates were not included in the Portainer backup: portainer/portainer#5497​
  • Fixed issue where editing an endpoint results in errors: portainer/portainer#5318​
  • Fixed upgrade issue where disconnected endpoints caused the upgrade to fail: portainer/portainer#5764​
  • Fixed issue with the layout of the add Environment Wizard: portainer/portainer#5801​
  • Fixed issue where the custom logo was not used in all places: portainer/portainer#5447​
  • Fixed issue where the DockerHub anonymous registry was being used instead of one with an account: portainer/portainer#5896​
  • Fixed issue where upgrade fails: portainer/portainer#5969​
  • Fixed issue where the Quick Setup wizard wasn't showing correctly when using the dark theme: portainer/portainer#5842​
  • Fixed issue where uploading a backup file could not select a file on Mac: portainer/portainer#5357​
  • Fixed issue where the URL of an Environment would change to localhost: portainer/portainer#5803​
  • Fixed issue where RBAC settings would be retained after removing an Environment from Portainer
  • Fixed issue where certificates would end up in the activity logs
  • Fixed issue when exporting activity logs as CSV without a data range set
  • Added a build for Windows Server 20H2: portainer/portainer#4971​
  • Added a build for Windows Server 21H2: portainer/portainer#5763​

Registries

ACI

  • Fixed issue where ACI stopped working when the number of exposed ports and container ports were different: portainer/portainer#5335​