portainer README

The project's README from github.com/portainer/portainer. As one markdown file: README.md.

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.

Latest Version

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

latest version

Getting started

Features & Functions

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

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.

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

Generating API types

The frontend consumes a TypeScript API client (SDK functions and request/response types) that is generated from the Go API's Swagger annotations. Regenerate it after any API change — a new endpoint, a changed request/response shape, or a removed endpoint:

make generate-api

This runs the following pipeline:

Go Swagger annotations
  → dist/docs/swagger.yaml       (make docs-build, via swaggo/swag)
  → dist/docs/openapi.yaml       (swagger2openapi + validation)
  → app/react/portainer/generated-api/portainer/   (hey-api/openapi-ts)

The generator is configured in openapi-ts.config.ts, which controls the output path, plugins, and tag filters (for example, deprecated endpoints and edge_agent-tagged routes are excluded).

The generated files live in app/react/portainer/generated-api/portainer/ and must not be edited by hand — your changes would be overwritten on the next run. Import the generated SDK functions and types instead of writing direct HTTP calls:

See Adding api docs for how to annotate handlers so they are picked up by the generator.

Security

For information about reporting security vulnerabilities, please see our Security Policy.

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 (portainer/portainer)

Searching Database…

38.7K ·GitHub
Portainer
这是什么？Portainer 是一个轻量级管理平台，适用于 Docker、Docker Swarm、Kubernetes 和 ACI 环境，你可以通过 Web 图形界面或 API 管理容器、镜像、卷和网络。
这是 Docker 扩展，还是我需要单独运行的应用？这是一个独立应用：Portainer 本身以单个容器运行（可在 Linux 上运行，也可作为原生 Windows 容器运行），并提供“智能”图形界面以及丰富的 API，用于控制其所连接的任意集群。
我该如何让它运行起来？你需要将 Portainer 本身作为容器部署，并指向你的 Docker、Swarm 或 Kubernetes 环境，参照 'Deploy Portainer' 指南操作，然后访问它提供的 Web 界面。
我需要先有现成的 Docker 或 Kubernetes 集群吗？需要。Portainer 管理的是已有的编排资源，因此你需要先搭建好 Docker、Swarm、Kubernetes 或 ACI 环境，供它连接。
我用的任何 Docker 版本它都支持吗？不是。Portainer 官方只支持当前 Docker 版本以及之前的两个版本；更旧的版本可能可以运行，但不受官方支持。
它只能在 Linux 上运行，还是 Windows 也可以？两者都可以：Portainer 可以作为 Linux 容器或原生 Windows 容器部署，因此适用于任一宿主操作系统。
Portainer CE 和 Portainer Business Edition 有什么区别？Portainer Business Edition 基于开源的 CE 代码库构建，并为企业用户增加了高级功能，例如 RBAC 和厂商支持；CE 版本由社区提供支持且免费。
我可以免费试用 Business Edition 吗？可以。Portainer 提供名为 'Take3' 的计划，可免费提供 3 个 Portainer Business 节点，使用期限不限。
前端的 API 客户端是从哪里来的？React 前端所使用的 TypeScript SDK 和请求/响应类型，是根据 Go 后端的 Swagger/OpenAPI 注解自动生成的，因此切勿手动编辑这些生成的文件。
What are similar projects?awesome-docker, dockge, laradock, slim, dockhand, hivepaas, labtether, distroless
Which topics is it in?docker-swarm, docker-container, docker-image, dockerfile, homelab, containers, kubernetes, docker-compose, dashboard, hacktoberfest, devops, ui
Creator
portainer
Size
89.6 MB
Stars
38.7K
Updated
CommitOct 16Release2.45.2Oct 08
Age
10y
Commits · 90 Days