2013-06-09 00:12:14 +00:00
2016-10-07 21:10:12 +00:00
< p align = "center" >
2017-06-17 15:05:34 +00:00
< img title = "portainer" src = 'https://portainer.io/images/logo_alt.png' / >
2016-10-07 21:10:12 +00:00
< / p >
2016-09-24 10:31:37 +00:00
2017-04-10 17:01:15 +00:00
[](https://hub.docker.com/r/portainer/portainer/)
2016-09-23 06:28:20 +00:00
[](http://microbadger.com/images/portainer/portainer "Image size")
2017-06-03 14:52:33 +00:00
[](http://portainer.readthedocs.io/en/stable/?badge=stable)
2017-05-25 10:17:51 +00:00
[]( https://g.codefresh.io/repositories/portainer/portainer/builds?filter=trigger:build;branch:develop;service:5922a08a3a1aab000116fcc6~portainer-ci)
2017-08-04 06:09:29 +00:00
[](https://codeclimate.com/github/portainer/portainer)
2017-06-17 15:05:34 +00:00
[](https://portainer.io/slack/)
2016-09-04 03:33:59 +00:00
[](https://gitter.im/portainer/Lobby?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2016-11-11 23:51:06 +00:00
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=YHXZJQNJQ36H6)
2016-09-04 03:33:59 +00:00
2017-06-30 12:52:04 +00:00
**_Portainer_** is a lightweight management UI which allows you to **easily** manage your different Docker environments (Docker hosts or Swarm clusters).
2013-06-09 00:12:14 +00:00
2017-06-30 12:52:04 +00:00
**_Portainer_** is meant to be as **simple** to deploy as it is to use. It consists of a single container that can run on any Docker engine (can be deployed as Linux container or a Windows native container).
2013-12-30 18:40:08 +00:00
2017-06-30 12:52:04 +00:00
**_Portainer_** allows you to manage your Docker containers, images, volumes, networks and more ! It is compatible with the *standalone Docker* engine and with *Docker Swarm mode* .
2014-12-30 19:42:54 +00:00
2016-10-07 21:10:12 +00:00
## Demo
2014-12-30 19:42:54 +00:00
2017-06-17 15:05:34 +00:00
< img src = "https://portainer.io/images/screenshots/portainer.gif" width = "77%" / >
2016-06-16 05:39:59 +00:00
2017-03-19 20:24:09 +00:00
You can try out the public demo instance: http://demo.portainer.io/ (login with the username **admin** and the password **tryportainer** ).
2016-06-23 22:11:25 +00:00
2016-10-07 21:10:12 +00:00
Please note that the public demo cluster is **reset every 15min** .
2016-06-16 05:39:59 +00:00
2017-12-02 08:39:10 +00:00
Alternatively, you can deploy a copy of the demo stack inside a [play-with-docker (PWD) ](https://labs.play-with-docker.com ) playground:
- Browse [PWD/?stack=portainer-demo/play-with-docker/docker-stack.yml ](http://play-with-docker.com/?stack=https://raw.githubusercontent.com/portainer/portainer-demo/master/play-with-docker/docker-stack.yml )
- Sign in with your [Docker ID ](https://docs.docker.com/docker-id )
- Follow [these ](https://github.com/portainer/portainer-demo/blob/master/play-with-docker/docker-stack.yml#L5-L8 ) steps.
Unlike the public demo, the playground sessions are deleted after 4 hours. Apart from that, all the settings are same, including default credentials.
2016-10-07 21:10:12 +00:00
## Getting started
2014-12-30 19:42:54 +00:00
2016-10-07 21:10:12 +00:00
* [Deploy Portainer ](https://portainer.readthedocs.io/en/latest/deployment.html )
* [Documentation ](https://portainer.readthedocs.io )
2016-06-23 22:11:49 +00:00
2016-10-07 21:10:12 +00:00
## Getting help
2016-07-12 08:31:11 +00:00
2016-10-07 21:10:12 +00:00
* Issues: https://github.com/portainer/portainer/issues
* FAQ: https://portainer.readthedocs.io/en/latest/faq.html
2017-06-30 12:52:04 +00:00
* Slack (chat): https://portainer.io/slack/
2016-10-07 21:10:12 +00:00
* Gitter (chat): https://gitter.im/portainer/Lobby
2016-07-12 08:31:11 +00:00
2016-10-07 21:10:12 +00:00
## Reporting bugs and contributing
2016-07-12 08:31:11 +00:00
2016-10-07 21:10:12 +00:00
* Want to report a bug or request a feature? Please open [an issue ](https://github.com/portainer/portainer/issues/new ).
* Want to help us build **_portainer_** ? Follow our [contribution guidelines ](https://portainer.readthedocs.io/en/latest/contribute.html ) to build it locally and make a pull request. We need all the help we can get!
2016-08-17 09:52:49 +00:00
2016-10-07 21:10:12 +00:00
## Limitations
2016-06-23 22:11:49 +00:00
2016-10-07 21:10:12 +00:00
**_Portainer_** has full support for the following Docker versions:
2016-08-23 06:09:14 +00:00
2017-05-23 15:54:14 +00:00
* Docker 1.10 to the latest version
2018-05-25 16:00:47 +00:00
* Standalone Docker Swarm >= 1.2.3 _(**NOTE:** Use of Standalone Docker Swarm is being discouraged since the introduction of built-in Swarm Mode in Docker. While older versions of Portainer had support for Standalone Docker Swarm, Portainer 1.17.0 and newer **do not** support it. However, the built-in Swarm Mode of Docker is fully supported.)_
2016-06-23 22:22:04 +00:00
2016-09-24 10:31:37 +00:00
Partial support for the following Docker versions (some features may not be available):
2016-06-23 22:22:04 +00:00
2016-09-24 10:31:37 +00:00
* Docker 1.9
2018-05-23 12:47:43 +00:00
## Licensing
Portainer is licensed under the zlib license. See [LICENSE ](./LICENSE ) for reference.
Portainer also contains the following code, which is licensed under the [MIT license ](https://opensource.org/licenses/MIT ):
UI For Docker: Copyright (c) 2013-2016 Michael Crosby (crosbymichael.com), Kevan Ahlquist (kevanahlquist.com), Anthony Lapenna (portainer.io)
rdash-angular: Copyright (c) [2014] [Elliot Hesp]
