更新README文件

This commit is contained in:
chishin 2024-01-19 12:57:25 +08:00
parent af56e548b1
commit 5b73b69dbe

View File

@ -6,7 +6,7 @@
<br>
</p>
本项目是基于 [NginxProxyManager/nginx-proxy-manager](https://github.com/NginxProxyManager/nginx-proxy-manager) 翻译的中文版本该项目属于一个预构建的docker映像它可以让你轻松地部署到你的网站上运行包括免费的SSL而不需要知道太多关于 Nginx 或 Let's Encrypt 的信息。
本项目是基于 [NginxProxyManager/nginx-proxy-manager](https://github.com/NginxProxyManager/nginx-proxy-manager) 翻译的中文版本该项目属于一个预构建的docker映像它可以让你轻松地部署到你的网站上运行包括免费的SSL而不需要知道太多关于 Nginx 或 Let's Encrypt 的信息。
![](http://image.xiaoxin.pro/2022/05/16/75687b5bfffbe.png)
@ -39,52 +39,93 @@ services:
- ./letsencrypt:/etc/letsencrypt
```
This is the bare minimum configuration required. See the [documentation](https://nginxproxymanager.com/setup/) for more.
3. Bring up your stack by running
### 3. 部署运行
```bash
docker-compose up -d
# If using docker-compose-plugin
docker compose up -d
```
4. Log in to the Admin UI
### 4. 登录管理页面
When your docker container is running, connect to it on port `81` for the admin interface.
Sometimes this can take a little bit because of the entropy of keys.
当你的docker容器成功运行使用浏览器访问`81`端口。
有些时候需要稍等一段时间。
[http://127.0.0.1:81](http://127.0.0.1:81)
Default Admin User:
默认管理员信息:
```
Email: admin@example.com
Password: changeme
```
Immediately after logging in with this default user you will be asked to modify your details and change your password.
使用这个默认用户登录后,系统会立即要求您修改详细信息和密码。
### 5. 快速升级
## Contributing
```bash
docker-compose down
docker-compose pull
docker-compose up -d
```
All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
这个项目将自动更新任何数据库或其他要求所以你不必遵循任何疯狂的指示。上面的这些步骤将提取最新的更新并重新创建docker容器。
CI is used in this project. All PR's must pass before being considered. After passing,
docker builds for PR's are available on dockerhub for manual verifications.
## 更多
Documentation within the `develop` branch is available for preview at
[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
### 1. 官方文档(英文)
关于本应用的更多用法请访问官方文档:
### Contributors
- [项目源码](https://github.com/NginxProxyManager/nginx-proxy-manager)
- [项目官网](https://nginxproxymanager.com/)
- [安装手册](https://nginxproxymanager.com/setup/)
- [高级配置](https://nginxproxymanager.com/advanced-config/#best-practice-use-a-docker-network)
- [常见问题](https://nginxproxymanager.com/faq/#do-i-have-to-use-docker)
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
### 2. 替换中文镜像
当你使用官方示例的`docker-compose`时需要注意将image镜像`jc21/nginx-proxy-manager`替换为`chishin/nginx-proxy-manager-zh`即可实现中文部署。
## Getting Support
### 3. 关于中文镜像
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
3. [Reddit](https://reddit.com/r/nginxproxymanager)
中文镜像并没有重新构建后端代码,由[Dockerfile-zh](https://github.com/xiaoxinpro/nginx-proxy-manager-zh/blob/develop-zh/docker/Dockerfile-zh)文件可以得知,中文镜像基于官方镜像替换前端代码来实现的,所以中文版本的全部功能与官方版本完全相同,只是显示界面的文字不同的区别。
### 4. 关于DNSPod创建证书失败
此问题在2.9.19版本开始就已经存在,原因是`zope`引起的由于ARM架构一直安装失败所以无法打包到镜像中建议使用如下方法修复此问题
首先确保nginx-proxy-manager-zh的Docker容器已经正常运行使用`docker-compose ps`查看容器名,这里假设容器名为`npm-zh`。
进入容器:(注意替换下文中的容器名)
```
docker exec -it npm-zh bash
```
执行安装`zope`命令:
```
python3 -m pip install --upgrade pip
pip install certbot-dns-dnspod
pip install zope
```
等待安装完成,退出容器:
```
exit
```
最后刷新浏览器再次使用DNSPod创建证书即可。
## 捐赠
如果您觉得本项目对你有帮助,欢迎给予我们一定的捐助来翻译项目的长期发展。
### 支付宝扫码捐赠
![支付宝扫码捐赠](https://image.xiaoxin.pro/2022/05/16/1f1a5f025c13c.png)
### 微信扫描捐赠
![微信扫描捐赠](https://image.xiaoxin.pro/2022/05/16/9c9906b102b29.png)