Comment on page
Install Portainer BE with Docker on Windows Container Service
Portainer consists of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers on a Docker engine. This document will help you install the Portainer Server container on your Windows server with Windows Containers. To add a new WCS environment to an existing Portainer Server installation, please refer to the Portainer Agent installation instructions.
To get started, you will need:
- Administrator access on the machine that will host your Portainer Server instance
- By default, Portainer Server will expose the UI over port
9443and expose a TCP tunnel server over port
8000. The latter is optional and is only required if you plan to use the Edge compute features with Edge agents.
- A license key for Portainer Business Edition.
The installation instructions also make the following assumption about your environment:
To run Portainer Server in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can easily be added through PowerShell by running the following commands:
netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377
netsh advfirewall firewall add rule name="node_communication_tcp" dir=in action=allow protocol=TCP localport=7946
netsh advfirewall firewall add rule name="node_communication_udp" dir=in action=allow protocol=UDP localport=7946
netsh advfirewall firewall add rule name="overlay_network" dir=in action=allow protocol=UDP localport=4789
netsh advfirewall firewall add rule name="swarm_dns_tcp" dir=in action=allow protocol=TCP localport=53
netsh advfirewall firewall add rule name="swarm_dns_udp" dir=in action=allow protocol=UDP localport=53
You will also need to install the Windows Container Host Service and install Docker:
Enable-WindowsOptionalFeature -Online -FeatureName containers -All
Install-Module -Name DockerMsftProvider -Repository PSGallery -Force
Install-Package -Name docker -ProviderName DockerMsftProvider
Once this is complete you will need to restart your Windows server. After the restart completes, you're ready to install Portainer itself.
First, create the volume that Portainer Server will use to store its database. Using PowerShell:
docker volume create portainer_data
Then, download and install the Portainer Server container:
docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ee:latest
If you see an error message similar to:
"\\.\pipe\dockerDesktopEngine" includes invalid characters for a local volume name
then you may not have Windows containers properly enabled. If you are using Docker Desktop, right click the icon in your tray and select Switch to Windows Containers.
If you require HTTP port
9000open for legacy reasons, add the following to your
Now that the installation is complete, you can log into your Portainer Server instance by opening a web browser and going to:
localhostwith the relevant IP address or FQDN if needed, and adjust the port if you changed it earlier.
You will be presented with the initial setup page for Portainer Server.