> For the complete documentation index, see [llms.txt](https://rocdu.gitbook.io/ingress-nginx-docs-cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rocdu.gitbook.io/ingress-nginx-docs-cn/master.md).

# ingress-nginx 中文文档

## mkdoc安装

```bash
pip install mkdocs-material
mkdocs serve
```

访问: <http://127.0.0.1:8000>

## 目录

* 欢迎:
  * [欢迎](/ingress-nginx-docs-cn/docs/index.md)
  * [如何工作](/ingress-nginx-docs-cn/docs/how-it-works.md)
  * [故障排查](/ingress-nginx-docs-cn/docs/troubleshooting.md)
  * [kubectl 插件](/ingress-nginx-docs-cn/docs/kubectl-plugin.md)
  * [开发](/ingress-nginx-docs-cn/docs/development.md)
* 部署:
  * [安装指南](/ingress-nginx-docs-cn/docs/deploy/index.md)
  * [裸机注意事项](/ingress-nginx-docs-cn/docs/deploy/baremetal.md)
  * [基于角色的访问控制(RBAC)](/ingress-nginx-docs-cn/docs/deploy/rbac.md)
  * [Validating Webhook (准入控制器)](/ingress-nginx-docs-cn/docs/deploy/validating-webhook.md)
  * [升级](/ingress-nginx-docs-cn/docs/deploy/upgrade.md)
* 用户指南:
  * nginx 配置:
    * [介绍](/ingress-nginx-docs-cn/docs/user-guide/nginx-configuration/index.md)
    * [基本用法](/ingress-nginx-docs-cn/docs/user-guide/basic-usage.md)
    * [注解](/ingress-nginx-docs-cn/docs/user-guide/nginx-configuration/annotations.md)
    * [ConfigMap](/ingress-nginx-docs-cn/docs/user-guide/nginx-configuration/configmap.md)
    * [自定义nginx模板](/ingress-nginx-docs-cn/docs/user-guide/nginx-configuration/custom-template.md)
    * [日志格式](/ingress-nginx-docs-cn/docs/user-guide/nginx-configuration/log-format.md)
  * [命令行参数](/ingress-nginx-docs-cn/docs/user-guide/cli-arguments.md)
  * [自定义错误](/ingress-nginx-docs-cn/docs/user-guide/custom-errors.md)
  * [默认后端](/ingress-nginx-docs-cn/docs/user-guide/default-backend.md)
  * [暴露TCP或UDP服务](/ingress-nginx-docs-cn/docs/user-guide/exposing-tcp-udp-services.md)
  * [暴露FCGI服务](/ingress-nginx-docs-cn/docs/user-guide/fcgi-services.md)
  * [路径中的正则表达式](https://github.com/du2016/ingress-nginx-docs-cn/tree/4de23547e0cca9515948b6ec6c779349f3a8ca9d/user-guide/ingress-path-matching.md)
  * [扩展阅读](/ingress-nginx-docs-cn/docs/user-guide/external-articles.md)
  * [杂项](/ingress-nginx-docs-cn/docs/user-guide/miscellaneous.md)
  * [安装Prometheus 和 Grafana](/ingress-nginx-docs-cn/docs/user-guide/monitoring.md)
  * [多Ingress控制器](/ingress-nginx-docs-cn/docs/user-guide/multiple-ingress.md)
  * [TLS/HTTPS](/ingress-nginx-docs-cn/docs/user-guide/tls.md)
  * 第三方插件:
    * [ModSecurity Web应用程序防火墙](/ingress-nginx-docs-cn/docs/user-guide/third-party-addons/modsecurity.md)
    * [OpenTracing](/ingress-nginx-docs-cn/docs/user-guide/third-party-addons/opentracing.md)
* 示例:
  * [介绍](/ingress-nginx-docs-cn/docs/examples/index.md)
  * [依赖](/ingress-nginx-docs-cn/docs/examples/prerequisites.md)
  * [回话粘滞性](/ingress-nginx-docs-cn/docs/examples/affinity/cookie.md)
  * 认证:
    * [基础认证](/ingress-nginx-docs-cn/docs/examples/auth/basic.md)
    * [客户端证书认证](/ingress-nginx-docs-cn/docs/examples/auth/client-certs.md)
    * [扩展基础认证](/ingress-nginx-docs-cn/docs/examples/auth/external-auth.md)
    * [扩展 OAUTH 认证](/ingress-nginx-docs-cn/docs/examples/auth/oauth-external-auth.md)
  * 定制化:
    * [配置片段](/ingress-nginx-docs-cn/docs/examples/customization/configuration-snippets.md)
    * [定义配置](/ingress-nginx-docs-cn/docs/examples/customization/custom-configuration.md)
    * [定义错误](/ingress-nginx-docs-cn/docs/examples/customization/custom-errors.md)
    * [定义Headers](/ingress-nginx-docs-cn/docs/examples/customization/custom-headers.md)
    * [扩展认证](/ingress-nginx-docs-cn/docs/examples/customization/external-auth-headers.md)
    * [自定义DH参数以实现完美的前向保密性](/ingress-nginx-docs-cn/docs/examples/customization/ssl-dh-param.md)
    * [系统调整](/ingress-nginx-docs-cn/docs/examples/customization/sysctl.md)
  * [Docker仓库](/ingress-nginx-docs-cn/docs/examples/docker-registry.md)
  * [gRPC](/ingress-nginx-docs-cn/docs/examples/grpc.md)
  * [多证书结束](/ingress-nginx-docs-cn/docs/examples/multi-tls.md)
  * [Rewrite](/ingress-nginx-docs-cn/docs/examples/rewrite.md)
  * [静态 IPs](/ingress-nginx-docs-cn/docs/examples/static-ip.md)
  * [TLS 种植](/ingress-nginx-docs-cn/docs/examples/tls-termination.md)
  * [Pod安全策略 (PSP)](/ingress-nginx-docs-cn/docs/examples/psp.md)