wehub-resource-sync
102 lines
5.4 KiB
Markdown
102 lines
5.4 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/portainer/portainer) · [上游 README](https://github.com/portainer/portainer/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
<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 Community Edition** 是一款轻量级的容器化应用服务交付平台，可用于管理 Docker、Swarm、Kubernetes 和 ACI 环境。其设计目标是部署简单、使用便捷。该应用允许你通过「智能」图形用户界面（GUI）和/或功能完善的 API 管理所有编排器资源（容器、镜像、卷、网络等）。
|
||
|
||
Portainer 由单个容器组成，可在任意集群上运行。它可以作为 Linux 容器或 Windows 原生容器进行部署。
|
||
|
||
**Portainer Business Edition（商业版）** 在开源版本基础上构建，包含一系列面向企业用户需求的高级功能（如 RBAC 和支持服务）。
|
||
|
||
- [对比 Portainer CE 与 Portainer BE](https://www.portainer.io/features)
|
||
- [Take3 – 按需获取 3 个免费的 Portainer Business 节点](https://www.portainer.io/take-3)
|
||
- [Portainer BE 安装指南](https://academy.portainer.io/install/)
|
||
|
||
## 最新版本
|
||
|
||
Portainer CE 会定期更新。我们目标每隔几个月发布一次更新版本。
|
||
|
||
[](https://github.com/portainer/portainer/releases/latest)
|
||
|
||
## 快速入门
|
||
|
||
- [部署 Portainer](https://docs.portainer.io/start/install-ce)
|
||
- [文档](https://docs.portainer.io)
|
||
- [参与项目贡献](https://docs.portainer.io/contribute/contribute)
|
||
|
||
## 功能特性
|
||
|
||
查看[此](https://www.portainer.io/features) 表格，了解 Portainer CE 的全部功能，并与 Portainer Business 进行对比。
|
||
|
||
## 获取帮助
|
||
|
||
Portainer CE 是一个开源项目，由社区提供支持。你可以在 portainer.io 购买受支持的 Portainer 版本。
|
||
|
||
在[此处](https://www.portainer.io/resources/get-help/get-support) 了解更多 Portainer 社区支持渠道。
|
||
|
||
- Issues: https://github.com/portainer/portainer/issues
|
||
- Slack（聊天）: [https://portainer.io/slack](https://portainer.io/slack)
|
||
|
||
你可以访问 [https://www.portainer.io/join-our-community](https://www.portainer.io/join-our-community). 加入 Portainer 社区。这将使你提前获知活动、内容及其他相关 Portainer 资讯。
|
||
|
||
## 报告 Bug 与贡献代码
|
||
|
||
- 想报告 Bug 或请求新功能？请提交 [issue](https://github.com/portainer/portainer/issues/new).
|
||
- 想帮助我们构建 **_portainer_**？请遵循我们的[贡献指南](https://docs.portainer.io/contribute/contribute) 在本地构建并提交 pull request。
|
||
|
||
## 生成 API 类型
|
||
|
||
前端使用基于 Go API 的 Swagger 注解生成的 TypeScript API 客户端（SDK 函数及请求/响应类型）。任何 API 变更后都应重新生成——新增端点、修改请求/响应结构或删除端点时：
|
||
|
||
```bash
|
||
make generate-api
|
||
```
|
||
|
||
该命令会执行以下流水线：
|
||
|
||
```
|
||
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)
|
||
```
|
||
|
||
生成器配置位于 [`openapi-ts.config.ts`](./openapi-ts.config.ts)，用于控制输出路径、插件及标签过滤器（例如，排除 `deprecated` 端点和 `edge_agent` 标签的路由）。
|
||
|
||
生成的文件位于 `app/react/portainer/generated-api/portainer/`，**切勿**手动编辑——你的修改会在下次运行时被覆盖。请导入生成的 SDK 函数和类型，而不是直接编写 HTTP 调用：
|
||
|
||
- `@api/sdk.gen` — SDK 函数
|
||
- `@api/types.gen` — 请求/响应类型
|
||
|
||
有关如何为 handler 添加注解以便生成器识别，请参阅 [Adding api docs](./CONTRIBUTING.md#adding-api-docs)。
|
||
|
||
## 安全
|
||
|
||
有关报告安全漏洞的信息，请参阅我们的[安全政策](SECURITY.md)。
|
||
|
||
## 加入我们
|
||
|
||
如果你是一名开发者，且能够理解本仓库中的代码，我们非常乐意听到你的消息。我们一直在寻找优秀的开发者，无论是自由职业者还是全职员工。请将你的详细信息发送至 success@portainer.io，和/或访问我们的[招聘页面](https://apply.workable.com/portainer/).
|
||
|
||
## 隐私
|
||
|
||
**为确保将开发精力集中在正确方向，我们需要了解哪些功能使用最频繁。为此，我们使用托管于德国且完全符合 GDPR 的 [Matomo Analytics](https://matomo.org/), 来收集这些信息。**
|
||
|
||
Portainer 首次启动时，你可以选择禁用数据分析。如果你**未**选择禁用，我们将根据[我们的隐私政策](https://www.portainer.io/legal/privacy-policy). 收集匿名使用数据。**请注意**，我们不会在任何时候发送或存储任何个人可识别信息，这些数据仅用于帮助我们改进 Portainer。
|
||
|
||
## 限制
|
||
|
||
Portainer 仅支持「当前版本减 2」以内的 Docker 版本。更早版本可能可以运行，但不受支持。
|
||
|
||
## 许可证
|
||
|
||
Portainer 采用 zlib 许可证。请参阅 [LICENSE](./LICENSE)。
|
||
|
||
Portainer 还包含来自开源项目的代码。完整列表请参阅 [ATTRIBUTIONS.md](./ATTRIBUTIONS.md)。
|