portainer/portainer

Making Docker and Kubernetes management easy.

Portainer Community Edition is a lightweight service delivery platform for containerized applications that can be used to manage Docker, Swarm, Kubernetes and ACI environments. It is designed to be as simple to deploy as it is to use. The application allows you to manage all your orchestrator resources (containers, images, volumes, networks and more) through a ‘smart’ GUI and/or an extensive API.

Portainer consists of a single container that can run on any cluster. It can be deployed as a Linux container or a Windows native container.

Portainer Business Edition builds on the open-source base and includes a range of advanced features and functions (like RBAC and Support) that are specific to the needs of business users.

• Compare Portainer CE and Compare Portainer BE
• Take3 – get 3 free nodes of Portainer Business for as long as you want them
• Portainer BE install guide

Latest Version

Portainer CE is updated regularly. We aim to do an update release every couple of months.

Getting started

• Deploy Portainer
• Documentation
• Contribute to the project

Features & Functions

View this table to see all of the Portainer CE functionality and compare to Portainer Business.

• Portainer CE for Docker / Docker Swarm
• Portainer CE for Kubernetes

Getting help

Portainer CE is an open source project and is supported by the community. You can buy a supported version of Portainer at portainer.io

Learn more about Portainer's community support channels here.

• Issues: https://github.com/portainer/portainer/issues
• Slack (chat): https://portainer.io/slack

You can join the Portainer Community by visiting https://www.portainer.io/join-our-community. This will give you advance notice of events, content and other related Portainer content.

Reporting bugs and contributing

• Want to report a bug or request a feature? Please open an issue.
• Want to help us build portainer? Follow our contribution guidelines to build it locally and make a pull request.

Security

• Here at Portainer, we believe in responsible disclosure of security issues. If you have found a security issue, please report it to [email protected].

Work for us

If you are a developer, and our code in this repo makes sense to you, we would love to hear from you. We are always on the hunt for awesome devs, either freelance or employed. Drop us a line to [email protected] with your details and/or visit our careers page.

Privacy

To make sure we focus our development effort in the right places we need to know which features get used most often. To give us this information we use Matomo Analytics, which is hosted in Germany and is fully GDPR compliant.

When Portainer first starts, you are given the option to DISABLE analytics. If you don't choose to disable it, we collect anonymous usage as per our privacy policy. Please note, there is no personally identifiable information sent or stored at any time and we only use the data to help us improve Portainer.

Limitations

Portainer supports "Current - 2 docker versions only. Prior versions may operate, however these are not supported.

Licensing

Portainer is licensed under the zlib license. See LICENSE for reference.

Portainer also contains code from open source projects. See ATTRIBUTIONS.md for a list.

portainer's Issues

Add the ability to specify Subnet/Gateway when creating a network

Add the fields Subnet and Gateway to the network creation view.

Line up dockerui flags with Docker CLI flags

We should line up the flags passed to the container with the Docker flags to provide a familiar API to anyone that's already in the docker ecosystem.

Changes:

• --endpoint, -e updated to --host, -H and must use the following format: tcp://mydockerhost.com or unix://path/to/socket
• add the --tlsverify flag to enable TLS support
• add the --tlscacert flag to specify the path to the CA
• add the --tlscert flag to specify the path to the TLS certificate file
• add the --tlskey flag to specify the path to the TLS key file

Review repository field in Images view

This field should be renamed to 'Names/Tags' and display all related tags not only the first one.

Form validation

At the moment there is no form validation in any creation view, from validation should be added for required fields at least.

Refactor grunt tasks

Taken from #300

All the following grunt tasks are similar except for their parameters:

• run
• runSwarm
• runSsl
• runSwarmLocal
  There should be a way to specify command line options/flags to grunt so we could actually refactor all these task into one.

It would be nice to be able to use the grunt command like this:

# Local portainer instance using /var/run/docker.sock
$ grunt run
# Local portainer instance in swarm mode
$ grunt run --swarm
# Remote portainer instance using -H tcp://IP:PORT
$ grunt run IP:PORT
# Remote portainer instance in swarm mode
$ grunt run IP:PORT --swarm

Being able to specify the IP:PORT of the remote instance on the command line would also be handy and avoid hardcoding fixed IP addresses in the gruntfile.

The same issue is present for for the buildBinary, buildUnixArmBinary and buildWindowsBinary grunt tasks.

See http://gruntjs.com/frequently-asked-questions#options

Revamp dashboard

The actual dashboard does not display enough information and is useless.

Need to review and replace it's content with useful information.

Events

A new section 'Events' should be added, it would display all the events related to container/images/volumes/networks with the ability to filter.

See: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#/monitor-docker-s-events

Coherent style for all entity tables

Actually only the container table in the containers view is using the class table-hover. Either the volume, network and image tables should use it all or none of them.

Duplicate a container

Sometimes, you want to create containers with the same configuration (network, volumes, command...) and actually you need to recreate a container from scratch.

Add the ability to duplicate an existing container configuration.

Display host IP of the container when Swarm mode enabled

In the container list, instead of showing the host node name it would be better to display the host IP address.

New volume creation view

Replace the volume creation popup with a specific view to create volumes.

Do not display duplicated volumes in Swarm mode

When the UI points to a Swarm cluster, the global volumes are listed for each node in the cluster (Docker Swarm standard behaviour).

It would be clearer to not display duplicates volumes.

Update README to define supported Docker versions

Inform about the current Docker version policy: N to N-3 where N is the latest Docker version.

Display more information about nodes in Swarm view

In the Swarm view, we need to display more information for each node in the cluster.

Interesting informations are:

• Node size (cpu/ram/disk)
• Node kernel version
• docker daemon config

Fix CSRF header issue when using grunt-dev

When using grunt-dev, a new container is created upon changes in the code. This cause the authKey.dat file to be recreated each time and leads to CSRF issues when trying to use POST requests against the Docker API.

Docker 1.10 support

The UI must work with Docker 1.10

Private registry management

The app should give access to the management of images inside a custom/private registry.

Ability to pull an image from a private registry

Currently the UI only supports pulling images from the DockerHub. It needs to be able to pull image from a custom/private registry.

Container console

Add the ability to connect to a container console from the UI.

Display all containers by default

Currently, stopped/exited containers are hidden from the containers view unless you enable Display All.

All containers should be listed, and exited/stopped containers should be hidden when disabling 'Show only running containers'.

CLI preview

Add a CLI preview in creation forms to display the Docker CLI command that would be created based on form parameters.

E.g. when creating a container with the following fields:

• Name: web
• image: nginx

The preview would output:

docker run --name web nginx:latest

Wide screen support

The UI is responsive to screen size using Bootstrap grid system, currently there's no way to support wide screens (e.g. width > 1500px) but this should be available in BS4.

twbs/bootstrap#12802

Container templates

Add a new section that will allow the user to deploy container in one click.

E.g. a view with a list of templates (Elasticsearch, MySQL, Tomcat...), the user then should have the choice between 'deploy' which will trigger a container creation with predefined parameters or 'run from' which will open the container creation view with predefined parameters autofilling the form.

The templates should be declared externally and be available via REST.

• Templates view
• Backend
• External definition
• Documentation

Hide containers with specific labels in the container view

As these containers are part of the Swarm cluster, they should be removed from the view inside the containers list.

Hidden containers are available via network inspect view

In the network inspect view, containers hidden via labels are still available in the connected endpoints list.

Docker Swarm events support

At the moment, Swarm API does not support events retrieval using the parameters since and until.

Track the following issue for updates:

• docker-archive/classicswarm#1203

Add a refresh button (or auto-refresh) for the list of containers

I'd like a way to refresh the list of containers without leaving the current tab.

Support latest Swarm version

Currently, the app supports only Swarm 1.2.0.

Update to be compliant with Swarm 1.2.3 /info API endpoint.

Add the ability to search events in a time frame

The current event view queries event for the last 24 hours. Docker restricts the number of events queried to the last 64 events.

Add the ability to specify a from and to parameters.

Add a registry field in the container creation view

This allows to pull an image from a custom registry from the container creation view.

Use minified versions of vendor scripts/css

Update the Grunt configuration to use minified versions of vendor/angular scripts/css.

Define a --swarm flag

The current version displays a Swarm tab in the UI. This tab should only be defined when connected to a Swarm endpoint.

Proposition: Start the application with a --swarm flag, when this flag is present, display the Swarm tab. If not, we'll consider that the application is connected to a Docker engine and then a Docker tab with information about the engine should be displayed.

Docker 1.9 support

The UI must work with Docker 1.9

New network creation view

Replace the network creation popup with a dedicated view.

Dynamic breadcrumb

The upper part of each view is used to display a breadcrumb of the app. This breadcrumb is currently static. It needs to be updated depending on the current view in the application.

Remove the pull image popup

This should be integrated on the top of the image view directly.

New container creation view

The current container creation tool is too messy, we need to have a cleaner/easier way to create containers.

Readonly user account

Add the ability to define 'read-only' user accounts.

Such accounts have the following permissions:

• Unable to start/alter/delete any resources (such as cannot create a container, execute actions against a container, remove an image...)
• Ability to inspect resources (such as inspect image details, container stats, containers logs...)
• An optional ability to use the container console

The 3rd option will be treated as an optional case during the user account creation (read only or read only with console access).

Remove extra space created by widget-header

See invertase/rdash-angular@d01d2f4

Replace angular-route with angular-ui-router

At the moment, both libraries cohabits in the project. Angular route should be removed and every href should be replaced with ui-sref.

Rename angular modules filter and services

The name of the modules are currently:

• dockerui.filters
• dockerui.services

Rename them to uifordocker.filters and uifordocker.services to stay coherent with the rest of the app.

Pull image before running container

Actually, when trying to start a container with an image that is not present on the Docker host an error is issued 'No such image:'.

The image should be pulled before trying to run the container.

Update image preview in README

The UI preview should be updated with the latest screenshot from the dashboard.

Externalize available volume drivers

When creating a new volume, the available drivers are displayed in a select. These drivers are currently hardcoded in the app/components/createVolume/createVolumeController file.

See:
https://github.com/cloud-inovasi/cloudinovasi-ui/blob/develop/app/components/createVolume/createVolumeController.js#L12

Available drivers should be defined somewhere else and must be easily configurable by the user.

Prometheus integration

Add the ability to poll metrics from a Prometheus backend.

Metrics from node_exporter to be added in the Swarm view.

Metrics from cAdvisor should replace the metrics available in the stats view for a specific container.

Display an error message when trying to remove network with active endpoints

Actually, when trying to remove a network with active endpoints, a message is displayed 'Network deleted' but the network is not deleted due to having active endpoints.

An error message should be displayed instead.

Docker engine with TLS enabled support

Actually, the UI is not working with TLS enabled Docker engines. Need to support it.

Unable to remove running container

When trying to remove a running container, a message is issued 'Container removed' but the container is not removed as the -f option is not passed to the remove command.

Fix typo in Docker view

The Docker engine info table is called 'Cluster status'. This should be replaced with 'Engine status'.

ViewSpinner is not always triggered

When triggering actions that requires some processing time (such as creating a container, a network...) a spinner is displayed.

Sometimes, this spinner is not displayed which could lead to confusion.