portainer/README.md

69 lines
4.6 KiB
Markdown
Raw Normal View History

2016-10-07 21:10:12 +00:00
<p align="center">
2020-07-07 21:53:10 +00:00
<img title="portainer" src='https://github.com/portainer/portainer/blob/develop/app/assets/images/logo_alt.png?raw=true' />
2016-10-07 21:10:12 +00:00
</p>
2017-04-10 17:01:15 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/portainer/portainer.svg)](https://hub.docker.com/r/portainer/portainer/)
2020-05-11 22:30:12 +00:00
[![Microbadger](https://images.microbadger.com/badges/image/portainer/portainer.svg)](http://microbadger.com/images/portainer/portainer 'Image size')
2019-01-30 23:02:12 +00:00
[![Build Status](https://portainer.visualstudio.com/Portainer%20CI/_apis/build/status/Portainer%20CI?branchName=develop)](https://portainer.visualstudio.com/Portainer%20CI/_build/latest?definitionId=3&branchName=develop)
2017-08-04 06:09:29 +00:00
[![Code Climate](https://codeclimate.com/github/portainer/portainer/badges/gpa.svg)](https://codeclimate.com/github/portainer/portainer)
2016-11-11 23:51:06 +00:00
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](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).
2019-03-12 22:09:53 +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, supports other platforms too).
**_Portainer_** allows you to manage all your Docker resources (containers, images, volumes, networks and more!) It is compatible with the _standalone Docker_ engine and with _Docker Swarm mode_.
2016-10-07 21:10:12 +00:00
## Demo
You can try out the public demo instance: http://demo.portainer.io/ (login with the username **admin** and the password **tryportainer**).
2016-10-07 21:10:12 +00:00
Please note that the public demo cluster is **reset every 15min**.
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 the same, including default credentials.
2016-10-07 21:10:12 +00:00
## Getting started
2021-02-11 21:55:25 +00:00
- [Deploy Portainer](https://documentation.portainer.io/quickstart/)
2020-09-30 02:40:20 +00:00
- [Documentation](https://documentation.portainer.io)
- [Building Portainer](https://documentation.portainer.io/contributing/instructions/)
2016-10-07 21:10:12 +00:00
## Getting help
2021-01-17 20:30:17 +00:00
For FORMAL Support, please purchase a support subscription from here: https://www.portainer.io/products/portainer-business
2020-04-08 21:59:14 +00:00
2021-01-17 20:30:17 +00:00
For community support: You can find more information about Portainer's community support framework policy here: https://www.portainer.io/products/community-edition/customer-success
2020-04-08 21:59:14 +00:00
2020-05-11 22:30:12 +00:00
- Issues: https://github.com/portainer/portainer/issues
2020-09-30 02:40:20 +00:00
- FAQ: https://documentation.portainer.io
2020-05-11 22:30:12 +00:00
- Slack (chat): https://portainer.io/slack/
2016-10-07 21:10:12 +00:00
## Reporting bugs and contributing
2020-05-11 22:30: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://documentation.portainer.io/contributing/instructions/) to build it locally and make a pull request. We need all the help we can get!
## Security
2020-05-11 22:30:12 +00:00
- Here at Portainer, we believe in [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) of security issues. If you have found a security issue, please report it to <security@portainer.io>.
2020-08-31 10:17:03 +00:00
## 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](https://matomo.org/), which is hosted in Germany and is fully GDPR compliant.**
2020-08-31 10:17:03 +00:00
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](https://www.portainer.io/documentation/in-app-analytics-and-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.
2016-10-07 21:10:12 +00:00
## Limitations
2020-04-08 22:01:20 +00:00
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](./LICENSE) for reference.
2021-03-22 02:35:26 +00:00
Portainer also contains code from open source projects. See [ATTRIBUTIONS.md](./ATTRIBUTIONS.md) for a list.