# ingress-nginx 中文文档

## mkdoc安装

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

访问: [http://127.0.0.1:8000](http://127.0.0.1:8000)

## 目录

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