portainer/README.md

80 lines
4.6 KiB
Markdown
Raw Normal View History

2016-10-07 21:10:12 +00:00
<p align="center">
2021-08-04 03:01:49 +00:00
<img title="portainer" src='https://github.com/portainer/portainer/blob/develop/app/assets/images/portainer-github-banner.png?raw=true' />
2016-10-07 21:10:12 +00:00
</p>
2021-11-16 18:52:36 +00:00
**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.
2016-09-04 03:33:59 +00:00
2021-08-04 02:50:50 +00:00
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.
2021-11-16 18:52:36 +00:00
**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.
2021-11-16 18:52:36 +00:00
- [Compare Portainer CE and Compare Portainer BE](https://portainer.io/products)
- [Take5 get 5 free nodes of Portainer Business for as long as you want them](https://portainer.io/pricing/take5)
- [Portainer BE install guide](https://install.portainer.io)
2021-08-05 22:58:21 +00:00
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**.
2021-08-04 02:50:50 +00:00
## Latest Version
2021-08-04 02:50:50 +00:00
Portainer CE is updated regularly. We aim to do an update release every couple of months.
2021-11-16 18:52:36 +00:00
**The latest version of Portainer is 2.9.x**. Portainer is on version 2, the second number denotes the month of release.
2016-10-07 21:10:12 +00:00
## Getting started
2021-11-16 18:52:36 +00:00
- [Deploy Portainer](https://docs.portainer.io/v/ce-2.9/start/install)
2020-09-30 02:40:20 +00:00
- [Documentation](https://documentation.portainer.io)
2021-08-04 02:50:50 +00:00
- [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)
2016-10-07 21:10:12 +00:00
## Getting help
2021-08-04 02:50:50 +00:00
Portainer CE is an open source project and is supported by the community. You can buy a supported version of Portainer at portainer.io
2020-04-08 21:59:14 +00:00
Learn more about Portainer's community support channels [here.](https://www.portainer.io/community_help)
2020-04-08 21:59:14 +00:00
2020-05-11 22:30:12 +00:00
- Issues: https://github.com/portainer/portainer/issues
- Slack (chat): [https://portainer.io/slack](https://portainer.io/slack)
2021-08-04 02:50:50 +00:00
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.
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).
2021-11-16 18:52:36 +00:00
- 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.
## 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>.
2021-11-16 18:52:36 +00:00
## Work for us
2021-08-12 23:11:14 +00:00
2021-11-16 18:52:36 +00:00
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/or visit our [careers page](https://portainer.io/careers).
2021-08-12 23:11:14 +00:00
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.