mirror of https://github.com/portainer/portainer
79 lines
4.4 KiB
Markdown
79 lines
4.4 KiB
Markdown
<p align="center">
|
||
<img title="portainer" src='https://github.com/portainer/portainer/blob/develop/app/assets/images/portainer-github-banner.png?raw=true' />
|
||
</p>
|
||
|
||
**Portainer CE** is a lightweight ‘universal’ management GUI that can be used to **easily** manage Docker, Swarm, Kubernetes and ACI environments. It is designed to be as **simple** to deploy as it is to use.
|
||
|
||
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** allows you to manage all your orchestrator resources (containers, images, volumes, networks and more) through a super-simple graphical interface.
|
||
|
||
A fully supported version of Portainer is available for business use. Visit http://www.portainer.io to learn more
|
||
|
||
## Demo
|
||
|
||
You can try out the public demo instance: http://demo.portainer.io/ (login with the username **admin** and the password **tryportainer**).
|
||
|
||
Please note that the public demo cluster is **reset every 15min**.
|
||
|
||
## Latest Version
|
||
|
||
Portainer CE is updated regularly. We aim to do an update release every couple of months.
|
||
|
||
**The latest version of Portainer is 2.6.x** And you can find the release notes [here.](https://www.portainer.io/blog/new-portainer-ce-2.6.0-release)
|
||
Portainer is on version 2, the second number denotes the month of release.
|
||
|
||
## Getting started
|
||
|
||
- [Deploy Portainer](https://documentation.portainer.io/quickstart/)
|
||
- [Documentation](https://documentation.portainer.io)
|
||
- [Contribute to the project](https://documentation.portainer.io/contributing/instructions/)
|
||
|
||
## Features & Functions
|
||
|
||
View [this](https://www.portainer.io/products) table to see all of the Portainer CE functionality and compare to Portainer Business.
|
||
|
||
- [Portainer CE for Docker / Docker Swarm](https://www.portainer.io/solutions/docker)
|
||
- [Portainer CE for Kubernetes](https://www.portainer.io/solutions/kubernetes-ui)
|
||
- [Portainer CE for Azure ACI](https://www.portainer.io/solutions/serverless-containers)
|
||
|
||
## 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 Portainers community support channels [here.](https://www.portainer.io/help_about)
|
||
|
||
- Issues: https://github.com/portainer/portainer/issues
|
||
- Slack (chat): [https://portainer.slack.com/](https://join.slack.com/t/portainer/shared_invite/zt-txh3ljab-52QHTyjCqbe5RibC2lcjKA)
|
||
|
||
You can join the Portainer Community by visiting community.portainer.io. 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](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
|
||
|
||
- 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>.
|
||
|
||
## 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 info@portainer.io with your details and we will be in touch.
|
||
|
||
## 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.**
|
||
|
||
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.
|
||
|
||
## 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](./LICENSE) for reference.
|
||
|
||
Portainer also contains code from open source projects. See [ATTRIBUTIONS.md](./ATTRIBUTIONS.md) for a list.
|