Skip to content

Commit 20cc064

Browse files
xiaoxinproxiaoxinpro
committed
基于v2.12.6更新中文翻译
1 parent 356eaa0 commit 20cc064

File tree

17 files changed

+607
-113
lines changed

17 files changed

+607
-113
lines changed

‎.github/workflows/docker.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: GitHub Actions Docker Buildx
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- 'develop-zh'
7+
- 'zh-v[1-9].[0-9]+.[0-9]+'
8+
release:
9+
types: [published]
10+
jobs:
11+
Docker-Buildx:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v3
16+
- name: 添加Build环境变量
17+
run: |
18+
echo "BUILD_IMAGE=chishin/nginx-proxy-manager-zh" >> $GITHUB_ENV
19+
echo "BUILD_PLATFORM=linux/amd64,linux/arm64,linux/arm/7" >> $GITHUB_ENV
20+
echo "BUILD_VERSION=$(cat .version)" >> $GITHUB_ENV
21+
- name: 添加BuildTag环境变量（push）
22+
if: ${{ github.event_name == 'push'}}
23+
run: |
24+
echo "BUILD_TAG=-t ${BUILD_IMAGE}:dev-${BUILD_VERSION} -t ${BUILD_IMAGE}:dev" >> $GITHUB_ENV
25+
- name: 添加BuildTag环境变量（release）
26+
if: ${{ github.event_name == 'release'}}
27+
run: |
28+
echo "BUILD_TAG=-t ${BUILD_IMAGE}:${BUILD_VERSION} -t ${BUILD_IMAGE}:${BUILD_VERSION%.*} -t ${BUILD_IMAGE}:${BUILD_VERSION%.*.*} -t ${BUILD_IMAGE}:release -t ${BUILD_IMAGE}:latest" >> $GITHUB_ENV
29+
- name: 登录DockerHub账号
30+
env:
31+
DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}}
32+
DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}}
33+
run: echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
34+
- name: Docker Setup Buildx
35+
uses: docker/[email protected]
36+
- name: 输出Buildx环境变量
37+
run: |
38+
echo "BUILD_TAG=$BUILD_TAG"
39+
echo "BUILD_IMAGE=$BUILD_IMAGE"
40+
echo "BUILD_PLATFORM=$BUILD_PLATFORM"
41+
echo "BUILD_VERSION=$BUILD_VERSION"
42+
- name: Buildx Dockerfile
43+
run: |
44+
chmod -R 755 scripts
45+
./scripts/buildx-zh

‎.github/workflows/stale.yml‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎README-en.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<p align="center">
2+
<img src="https://nginxproxymanager.com/github.png">
3+
<br><br>
4+
<img src="https://img.shields.io/badge/version-2.12.6-green.svg?style=for-the-badge">
5+
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
6+
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
7+
</a>
8+
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
9+
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
10+
</a>
11+
</p>
12+
13+
This project comes as a pre-built docker image that enables you to easily forward to your websites
14+
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
15+
16+
- [Quick Setup](#quick-setup)
17+
- [Full Setup](https://nginxproxymanager.com/setup/)
18+
- [Screenshots](https://nginxproxymanager.com/screenshots/)
19+
20+
## Project Goal
21+
22+
I created this project to fill a personal need to provide users with a easy way to accomplish reverse
23+
proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
24+
While there might be advanced options they are optional and the project should be as simple as possible
25+
so that the barrier for entry here is low.
26+
27+
<a href="https://www.buymeacoffee.com/jc21" target="_blank"><img src="http://public.jc21.com/github/by-me-a-coffee.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>
28+
29+
30+
## Features
31+
32+
- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
33+
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
34+
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
35+
- Access Lists and basic HTTP Authentication for your hosts
36+
- Advanced Nginx configuration available for super users
37+
- User management, permissions and audit log
38+
39+
40+
## Hosting your home network
41+
42+
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
43+
44+
1. Your home router will have a Port Forwarding section somewhere. Log in and find it
45+
2. Add port forwarding for port 80 and 443 to the server hosting this project
46+
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53](https://github.com/jc21/route53-ddns)
47+
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
48+
49+
## Quick Setup
50+
51+
1. Install Docker and Docker-Compose
52+
53+
- [Docker Install documentation](https://docs.docker.com/install/)
54+
- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
55+
56+
2. Create a docker-compose.yml file similar to this:
57+
58+
```yml
59+
version: '3.8'
60+
services:
61+
app:
62+
image: 'jc21/nginx-proxy-manager:latest'
63+
restart: unless-stopped
64+
ports:
65+
- '80:80'
66+
- '81:81'
67+
- '443:443'
68+
volumes:
69+
- ./data:/data
70+
- ./letsencrypt:/etc/letsencrypt
71+
```
72+
73+
This is the bare minimum configuration required. See the [documentation](https://nginxproxymanager.com/setup/) for more.
74+
75+
3. Bring up your stack by running
76+
77+
```bash
78+
docker-compose up -d
79+
80+
# If using docker-compose-plugin
81+
docker compose up -d
82+
83+
```
84+
85+
4. Log in to the Admin UI
86+
87+
When your docker container is running, connect to it on port `81` for the admin interface.
88+
Sometimes this can take a little bit because of the entropy of keys.
89+
90+
[http://127.0.0.1:81](http://127.0.0.1:81)
91+
92+
Default Admin User:
93+
```
94+
Email: [email protected]
95+
Password: changeme
96+
```
97+
98+
Immediately after logging in with this default user you will be asked to modify your details and change your password.
99+
100+
101+
## Contributors
102+
103+
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
104+
105+
106+
## Getting Support
107+
108+
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
109+
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
110+
3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
111+
4. [Reddit](https://reddit.com/r/nginxproxymanager)

‎README.md‎

Lines changed: 83 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,35 @@
1-
<p align="center">
2-
<img src="https://nginxproxymanager.com/github.png">
3-
<br><br>
4-
<img src="https://img.shields.io/badge/version-2.12.6-green.svg?style=for-the-badge">
5-
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
6-
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
7-
</a>
8-
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
9-
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
10-
</a>
11-
</p>
12-
13-
This project comes as a pre-built docker image that enables you to easily forward to your websites
14-
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
15-
16-
- [Quick Setup](#quick-setup)
17-
- [Full Setup](https://nginxproxymanager.com/setup/)
18-
- [Screenshots](https://nginxproxymanager.com/screenshots/)
19-
20-
## Project Goal
211

22-
I created this project to fill a personal need to provide users with an easy way to accomplish reverse
23-
proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
24-
While there might be advanced options they are optional and the project should be as simple as possible
25-
so that the barrier for entry here is low.
2+
[Original English README](https://github.com/xiaoxinpro/nginx-proxy-manager-zh/blob/develop-zh/README-en.md)
263

27-
<a href="https://www.buymeacoffee.com/jc21" target="_blank"><img src="http://public.jc21.com/github/by-me-a-coffee.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>
28-
29-
30-
## Features
31-
32-
- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
33-
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
34-
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
35-
- Access Lists and basic HTTP Authentication for your hosts
36-
- Advanced Nginx configuration available for super users
37-
- User management, permissions and audit log
4+
<p align="center">
5+
<img src="https://nginxproxymanager.com/github.png">
6+
<br>
7+
</p>
388

9+
本项目是基于 [NginxProxyManager/nginx-proxy-manager](https://github.com/NginxProxyManager/nginx-proxy-manager) 翻译的中文版本，该项目属于一个预构建的docker映像，它可以让你轻松地部署到你的网站上运行，包括免费的SSL，而不需要知道太多关于 Nginx 或 Let's Encrypt 的信息。
3910

40-
## Hosting your home network
11+
![](http://image.xiaoxin.pro/2022/05/16/75687b5bfffbe.png)
4112

42-
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
13+
## 快速部署
4314

44-
1. Your home router will have a Port Forwarding section somewhere. Log in and find it
45-
2. Add port forwarding for port 80 and 443 to the server hosting this project
46-
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53](https://github.com/jc21/route53-ddns)
47-
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
15+
### 1. 环境部署
4816

49-
## Quick Setup
17+
安装Docker和Docker-compose
5018

51-
1. Install Docker and Docker-Compose
19+
- [Docker官方安装文档（英文）](https://docs.docker.com/install/)
20+
- [Docker-Compose官方安装文档（英文）](https://docs.docker.com/compose/install/)
21+
- **[Docker和Docker-compose安装文档（中文）](https://blog.csdn.net/zhangzejin3883/article/details/124778945)**
5222

53-
- [Docker Install documentation](https://docs.docker.com/install/)
54-
- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
23+
### 2. 创建YAML文件
5524

56-
2. Create a docker-compose.yml file similar to this:
25+
创建一个 `docker-compose.yml` 文件:
5726

5827
```yml
28+
version: '3'
5929
services:
6030
app:
61-
image: 'docker.io/jc21/nginx-proxy-manager:latest'
62-
restart: unless-stopped
31+
image: 'chishin/nginx-proxy-manager-zh:release'
32+
restart: always
6333
ports:
6434
- '80:80'
6535
- '81:81'
@@ -69,52 +39,93 @@ services:
6939
- ./letsencrypt:/etc/letsencrypt
7040
```
7141
72-
This is the bare minimum configuration required. See the [documentation](https://nginxproxymanager.com/setup/) for more.
73-
74-
3. Bring up your stack by running
42+
### 3. 部署运行
7543
7644
```bash
7745
docker-compose up -d
78-
79-
# If using docker-compose-plugin
80-
docker compose up -d
81-
8246
```
8347

84-
4. Log in to the Admin UI
48+
### 4. 登录管理页面
8549

86-
When your docker container is running, connect to it on port `81` for the admin interface.
87-
Sometimes this can take a little bit because of the entropy of keys.
50+
当你的docker容器成功运行，使用浏览器访问`81`端口。
51+
有些时候需要稍等一段时间。
8852

8953
[http://127.0.0.1:81](http://127.0.0.1:81)
9054

91-
Default Admin User:
55+
默认管理员信息:
9256
```
9357
Email: [email protected]
9458
Password: changeme
9559
```
9660

97-
Immediately after logging in with this default user you will be asked to modify your details and change your password.
61+
使用这个默认用户登录后，系统会立即要求您修改详细信息和密码。
62+
63+
### 5. 快速升级
64+
65+
```bash
66+
docker-compose down
67+
docker-compose pull
68+
docker-compose up -d
69+
```
70+
71+
这个项目将自动更新任何数据库或其他要求，所以你不必遵循任何疯狂的指示。上面的这些步骤将提取最新的更新并重新创建docker容器。
9872

73+
## 更多
9974

100-
## Contributing
75+
### 1. 官方文档（英文）
10176

102-
All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
77+
关于本应用的更多用法请访问官方文档：
10378

104-
CI is used in this project. All PR's must pass before being considered. After passing,
105-
docker builds for PR's are available on dockerhub for manual verifications.
79+
- [项目源码](https://github.com/NginxProxyManager/nginx-proxy-manager)
80+
- [项目官网](https://nginxproxymanager.com/)
81+
- [安装手册](https://nginxproxymanager.com/setup/)
82+
- [高级配置](https://nginxproxymanager.com/advanced-config/#best-practice-use-a-docker-network)
83+
- [常见问题](https://nginxproxymanager.com/faq/#do-i-have-to-use-docker)
84+
85+
### 2. 替换中文镜像
86+
87+
当你使用官方示例的`docker-compose`时需要注意，将image镜像`jc21/nginx-proxy-manager`替换为`chishin/nginx-proxy-manager-zh`即可实现中文部署。
88+
89+
### 3. 关于中文镜像
90+
91+
中文镜像并没有重新构建后端代码，由[Dockerfile-zh](https://github.com/xiaoxinpro/nginx-proxy-manager-zh/blob/develop-zh/docker/Dockerfile-zh)文件可以得知，中文镜像基于官方镜像替换前端代码来实现的，所以中文版本的全部功能与官方版本完全相同，只是显示界面的文字不同的区别。
92+
93+
### 4. 关于DNSPod创建证书失败
94+
95+
此问题在2.9.19版本开始就已经存在，原因是`zope`引起的，由于ARM架构一直安装失败所以无法打包到镜像中，建议使用如下方法修复此问题：
96+
97+
首先确保nginx-proxy-manager-zh的Docker容器已经正常运行，使用`docker-compose ps`查看容器名，这里假设容器名为`npm-zh`。
98+
99+
进入容器：（注意替换下文中的容器名）
100+
101+
```
102+
docker exec -it npm-zh bash
103+
```
104+
105+
执行安装`zope`命令：
106+
107+
```
108+
python3 -m pip install --upgrade pip
109+
pip install certbot-dns-dnspod
110+
pip install zope
111+
```
112+
113+
等待安装完成，退出容器：
114+
115+
```
116+
exit
117+
```
106118

107-
Documentation within the `develop` branch is available for preview at
108-
[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
119+
最后刷新浏览器，再次使用DNSPod创建证书即可。
109120

121+
## 捐赠
110122

111-
### Contributors
123+
如果您觉得本项目对你有帮助，欢迎给予我们一定的捐助来翻译项目的长期发展。
112124

113-
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
125+
### 支付宝扫码捐赠
114126

127+
![支付宝扫码捐赠](https://image.xiaoxin.pro/2022/05/16/1f1a5f025c13c.png)
115128

116-
## Getting Support
129+
### 微信扫描捐赠
117130

118-
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
119-
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
120-
3. [Reddit](https://reddit.com/r/nginxproxymanager)
131+
![微信扫描捐赠](https://image.xiaoxin.pro/2022/05/16/9c9906b102b29.png)

0 commit comments

Comments
 (0)