基于v2.11.3更新中文翻译

xiaoxinpro · Aug 1, 2024 · 3cfa92b · 3cfa92b
1 parent 35d7a3a
commit 3cfa92b
Show file tree

Hide file tree

Showing 18 changed files with 693 additions and 113 deletions.
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -0,0 +1,45 @@
+name: GitHub Actions Docker Buildx
+on:
+ workflow_dispatch:
+ push:
+  branches:
+   - 'develop-zh'
+   - 'zh-v[1-9].[0-9]+.[0-9]+'
+ release:
+   types: [published]
+jobs:
+  Docker-Buildx:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: 添加Build环境变量
+        run: |
+          echo "BUILD_IMAGE=chishin/nginx-proxy-manager-zh" >> $GITHUB_ENV
+          echo "BUILD_PLATFORM=linux/amd64,linux/arm64,linux/arm/7" >> $GITHUB_ENV
+          echo "BUILD_VERSION=$(cat .version)" >> $GITHUB_ENV
+      - name: 添加BuildTag环境变量（push）
+        if: ${{ github.event_name == 'push'}}
+        run: |
+          echo "BUILD_TAG=-t ${BUILD_IMAGE}:dev-${BUILD_VERSION} -t ${BUILD_IMAGE}:dev" >> $GITHUB_ENV
+      - name: 添加BuildTag环境变量（release）
+        if: ${{ github.event_name == 'release'}}
+        run: |
+          echo "BUILD_TAG=-t ${BUILD_IMAGE}:${BUILD_VERSION} -t ${BUILD_IMAGE}:${BUILD_VERSION%.*} -t ${BUILD_IMAGE}:${BUILD_VERSION%.*.*} -t ${BUILD_IMAGE}:release" >> $GITHUB_ENV
+      - name: 登录DockerHub账号
+        env:
+          DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}}
+          DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}}
+        run: echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
+      - name: Docker Setup Buildx
+        uses: docker/[email protected]
+      - name: 输出Buildx环境变量
+        run: |
+          echo "BUILD_TAG=$BUILD_TAG"
+          echo "BUILD_IMAGE=$BUILD_IMAGE"
+          echo "BUILD_PLATFORM=$BUILD_PLATFORM"
+          echo "BUILD_VERSION=$BUILD_VERSION"
+      - name: Buildx Dockerfile
+        run: |
+          chmod -R 755 scripts
+          ./scripts/buildx-zh
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
diff --git a/README-en.md b/README-en.md
@@ -0,0 +1,111 @@
+<p align="center">
+	<img src="https://nginxproxymanager.com/github.png">
+	<br><br>
+	<img src="https://img.shields.io/badge/version-2.11.3-green.svg?style=for-the-badge">
+	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
+		<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
+	</a>
+	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
+		<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
+	</a>
+</p>
+
+This project comes as a pre-built docker image that enables you to easily forward to your websites
+running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
+
+- [Quick Setup](#quick-setup)
+- [Full Setup](https://nginxproxymanager.com/setup/)
+- [Screenshots](https://nginxproxymanager.com/screenshots/)
+
+## Project Goal
+
+I created this project to fill a personal need to provide users with a easy way to accomplish reverse
+proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
+While there might be advanced options they are optional and the project should be as simple as possible
+so that the barrier for entry here is low.
+
+<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>
+
+
+## Features
+
+- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
+- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
+- Free SSL using Let's Encrypt or provide your own custom SSL certificates
+- Access Lists and basic HTTP Authentication for your hosts
+- Advanced Nginx configuration available for super users
+- User management, permissions and audit log
+
+
+## Hosting your home network
+
+I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
+
+1. Your home router will have a Port Forwarding section somewhere. Log in and find it
+2. Add port forwarding for port 80 and 443 to the server hosting this project
+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)
+4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
+
+## Quick Setup
+
+1. Install Docker and Docker-Compose
+
+- [Docker Install documentation](https://docs.docker.com/install/)
+- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
+
+2. Create a docker-compose.yml file similar to this:
+
+```yml
+version: '3.8'
+services:
+  app:
+    image: 'jc21/nginx-proxy-manager:latest'
+    restart: unless-stopped
+    ports:
+      - '80:80'
+      - '81:81'
+      - '443:443'
+    volumes:
+      - ./data:/data
+      - ./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
+
+```bash
+docker-compose up -d
+
+# If using docker-compose-plugin
+docker compose up -d
+
+```
+
+4. Log in to the Admin UI
+
+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.
+
+[http://127.0.0.1:81](http://127.0.0.1:81)
+
+Default Admin User:
+```
+Email:    [email protected]
+Password: changeme
+```
+
+Immediately after logging in with this default user you will be asked to modify your details and change your password.
+
+
+## Contributors
+
+Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
+
+
+## Getting Support
+
+1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
+2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
+3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
+4. [Reddit](https://reddit.com/r/nginxproxymanager)
diff --git a/README.md b/README.md
@@ -1,65 +1,35 @@
-<p align="center">
-	<img src="https://nginxproxymanager.com/github.png">
-	<br><br>
-	<img src="https://img.shields.io/badge/version-2.11.3-green.svg?style=for-the-badge">
-	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
-		<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
-	</a>
-	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
-		<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
-	</a>
-</p>
-
-This project comes as a pre-built docker image that enables you to easily forward to your websites
-running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
-
-- [Quick Setup](#quick-setup)
-- [Full Setup](https://nginxproxymanager.com/setup/)
-- [Screenshots](https://nginxproxymanager.com/screenshots/)
-
-## Project Goal
 
-I created this project to fill a personal need to provide users with an easy way to accomplish reverse
-proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
-While there might be advanced options they are optional and the project should be as simple as possible
-so that the barrier for entry here is low.
+[Original English README](https://github.com/xiaoxinpro/nginx-proxy-manager-zh/blob/develop-zh/README-en.md)
 
-<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>
-
-
-## Features
-
-- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
-- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
-- Free SSL using Let's Encrypt or provide your own custom SSL certificates
-- Access Lists and basic HTTP Authentication for your hosts
-- Advanced Nginx configuration available for super users
-- User management, permissions and audit log
+<p align="center">
+    <img src="https://nginxproxymanager.com/github.png">
+    <br>
+</p>
 
+本项目是基于 [NginxProxyManager/nginx-proxy-manager](https://github.com/NginxProxyManager/nginx-proxy-manager) 翻译的中文版本，该项目属于一个预构建的docker映像，它可以让你轻松地部署到你的网站上运行，包括免费的SSL，而不需要知道太多关于 Nginx 或 Let's Encrypt 的信息。  
 
-## Hosting your home network
+![](http://image.xiaoxin.pro/2022/05/16/75687b5bfffbe.png)
 
-I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
+## 快速部署
 
-1. Your home router will have a Port Forwarding section somewhere. Log in and find it
-2. Add port forwarding for port 80 and 443 to the server hosting this project
-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)
-4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
+### 1. 环境部署
 
-## Quick Setup
+安装Docker和Docker-compose
 
-1. Install Docker and Docker-Compose
+- [Docker官方安装文档（英文）](https://docs.docker.com/install/)
+- [Docker-Compose官方安装文档（英文）](https://docs.docker.com/compose/install/)
+- **[Docker和Docker-compose安装文档（中文）](https://blog.csdn.net/zhangzejin3883/article/details/124778945)**
 
-- [Docker Install documentation](https://docs.docker.com/install/)
-- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
+### 2. 创建YAML文件
 
-2. Create a docker-compose.yml file similar to this:
+创建一个 `docker-compose.yml` 文件:
 
 ```yml
+version: '3'
 services:
   app:
-    image: 'docker.io/jc21/nginx-proxy-manager:latest'
-    restart: unless-stopped
+    image: 'chishin/nginx-proxy-manager-zh:release'
+    restart: always
     ports:
       - '80:80'
       - '81:81'
@@ -69,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:    [email protected]
 Password: changeme
 ```
 
-Immediately after logging in with this default user you will be asked to modify your details and change your password.
+使用这个默认用户登录后，系统会立即要求您修改详细信息和密码。
+
+### 5. 快速升级
+
+```bash
+docker-compose down
+docker-compose pull
+docker-compose up -d
+```
+
+这个项目将自动更新任何数据库或其他要求，所以你不必遵循任何疯狂的指示。上面的这些步骤将提取最新的更新并重新创建docker容器。
 
+## 更多
 
-## Contributing
+### 1. 官方文档（英文）
 
-All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
+关于本应用的更多用法请访问官方文档：
 
-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.
+- [项目源码](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)
+
+### 2. 替换中文镜像
+
+当你使用官方示例的`docker-compose`时需要注意，将image镜像`jc21/nginx-proxy-manager`替换为`chishin/nginx-proxy-manager-zh`即可实现中文部署。
+
+### 3. 关于中文镜像
+
+中文镜像并没有重新构建后端代码，由[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
+```
 
-Documentation within the `develop` branch is available for preview at
-[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
+最后刷新浏览器，再次使用DNSPod创建证书即可。
 
+## 捐赠
 
-### Contributors
+如果您觉得本项目对你有帮助，欢迎给予我们一定的捐助来翻译项目的长期发展。
 
-Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
+### 支付宝扫码捐赠
 
+![支付宝扫码捐赠](https://image.xiaoxin.pro/2022/05/16/1f1a5f025c13c.png)
 
-## Getting Support
+### 微信扫描捐赠
 
-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)
+![微信扫描捐赠](https://image.xiaoxin.pro/2022/05/16/9c9906b102b29.png)