Skip to content

Commit 71bc9c1

Browse files
authored
Merge pull request #1016 from GitHub30/patch-1
Add README file in Japanese
2 parents ed82069 + b23a8fc commit 71bc9c1

File tree

2 files changed

+391
-1
lines changed

2 files changed

+391
-1
lines changed

README-ja_JP.md

Lines changed: 390 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,390 @@
1+
<div align="center">
2+
<img src="resources/logo.png" alt="Nginx UI Logo">
3+
</div>
4+
5+
# Nginx UI
6+
7+
もう一つのNginx Web UI [0xJacky](https://jackyu.cn/), [Hintay](https://blog.kugeek.com/), [Akino](https://github.com/akinoccc)によって開発されました。
8+
9+
[![DeepWiki](https://img.shields.io/badge/DeepWiki-0xJacky%2Fnginx--ui-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/0xJacky/nginx-ui)
10+
11+
[![Build and Publish](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml/badge.svg)](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml)
12+
[![GitHub license](https://img.shields.io/github/license/0xJacky/nginx-ui?label=License&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on Github")
13+
[![Release Version](https://img.shields.io/github/release/0xJacky/nginx-ui?include_prereleases&label=Release&logo=github)](https://github.com/0xJacky/nginx-ui/releases/latest "Click to view the repo on Github")
14+
[![GitHub Star](https://img.shields.io/github/stars/0xJacky/nginx-ui?label=Stars&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on Github")
15+
[![GitHub Fork](https://img.shields.io/github/forks/0xJacky/nginx-ui?label=Forks&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on Github")
16+
[![Repo Size](https://img.shields.io/github/repo-size/0xJacky/nginx-ui?label=Size&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on Github")
17+
[![GitHub Fork](https://img.shields.io/github/issues-closed-raw/0xJacky/nginx-ui?label=Closed%20Issue&logo=github)](https://github.com/0xJacky/nginx-ui/issue "Click to view the repo on Github")
18+
19+
[![Docker Stars](https://img.shields.io/docker/stars/uozi/nginx-ui?label=Stars&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub")
20+
[![Docker Pulls](https://img.shields.io/docker/pulls/uozi/nginx-ui?label=Pulls&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub")
21+
[![Image Size](https://img.shields.io/docker/image-size/uozi/nginx-ui/latest?label=Image%20Size&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub")
22+
23+
[![Translated Status](https://weblate.nginxui.com/widget/nginx-ui/frontend/svg-badge.svg)](https://weblate.nginxui.com/engage/nginx-ui/)
24+
[![Featured|HelloGitHub](https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=86f3a8f779934748a34fe6f1b5cd442f&claim_uid=MOFqadzAShCBeQj&theme=small)](https://hellogithub.com/repository/86f3a8f779934748a34fe6f1b5cd442f)
25+
26+
## ドキュメント
27+
公式ドキュメントは [nginxui.com](https://nginxui.com) を参照してください。
28+
29+
## スター推移
30+
31+
[![Stargazers over time](https://starchart.cc/0xJacky/nginx-ui.svg)](https://starchart.cc/0xJacky/nginx-ui)
32+
33+
English | [Español](README-es.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md) | [Tiếng Việt](README-vi_VN.md) | [日本語](README-ja_JP.md)
34+
35+
<details>
36+
<summary>目次</summary>
37+
<ol>
38+
<li>
39+
<a href="#about-the-project">プロジェクトについて</a>
40+
<ul>
41+
<li><a href="#demo">デモ</a></li>
42+
<li><a href="#features">機能</a></li>
43+
<li><a href="#internationalization">多言語化</a></li>
44+
<li><a href="#built-with">主要技術</a></li>
45+
</ul>
46+
</li>
47+
<li>
48+
<a href="#getting-started">はじめに</a>
49+
<ul>
50+
<li><a href="#before-use">使用前の注意</a></li>
51+
<li><a href="#installation">インストール</a></li>
52+
<li>
53+
<a href="#usage">使い方</a>
54+
<ul>
55+
<li><a href="#from-executable">実行ファイルから</a></li>
56+
<li><a href="#with-systemd">Systemdで</a></li>
57+
<li><a href="#with-docker">Dockerで</a></li>
58+
</ul>
59+
</li>
60+
</ul>
61+
</li>
62+
<li>
63+
<a href="#manual-build">手動ビルド</a>
64+
<ul>
65+
<li><a href="#prerequisites">前提条件</a></li>
66+
<li><a href="#build-app">フロントエンドのビルド</a></li>
67+
<li><a href="#build-backend">バックエンドのビルド</a></li>
68+
</ul>
69+
</li>
70+
<li>
71+
<a href="#script-for-linux">Linux用スクリプト</a>
72+
<ul>
73+
<li><a href="#basic-usage">基本的な使い方</a></li>
74+
<li><a href="#more-usage">その他の使い方</a></li>
75+
</ul>
76+
</li>
77+
<li><a href="#example-of-nginx-reverse-proxy-configuration">Nginx リバースプロキシ設定例</a></li>
78+
<li><a href="#contributing">貢献方法</a></li>
79+
<li><a href="#license">ライセンス</a></li>
80+
</ol>
81+
</details>
82+
83+
## プロジェクトについて
84+
85+
![ダッシュボード](resources/screenshots/dashboard_en.png)
86+
87+
### デモ
88+
URL:[https://demo.nginxui.com](https://demo.nginxui.com)
89+
- ユーザー名:admin
90+
- パスワード:admin
91+
92+
### 機能
93+
94+
- サーバーの CPU 使用率、メモリ使用率、ロードアベレージ、ディスク使用率 とかの指標をオンラインで見られるんやで。
95+
- 設定変更したら自動でバックアップ作ってくれて、バージョン比較&復元もできるんやわ。
96+
- クラスタ管理で複数ノードへのミラーリング操作もサポートしてるから、大規模環境でも楽勝や。
97+
- 暗号化した Nginx / Nginx UI の設定をエクスポートして、新環境へのデプロイ&復旧がサクッとできるで。
98+
- オンライン ChatGPT アシスタント(Deepseek-R1 のチェインオブソート表示付き)で設定の最適化や理解をサポートしてくれるんや。
99+
- MCP(Model Context Protocol)で AI エージェントが Nginx UI と連携できる特別インターフェースもあるから、自動化もバッチリや。
100+
- ワンクリックで Let’s Encrypt 証明書の発行&自動更新もしてくれるし。
101+
- 自社開発の **NgxConfigEditor**(ブロックエディタ)か、**Ace Code Editor**(LLM コード補完&シンタックスハイライト付き)で nginx 設定を直感的に編集でけるんや。
102+
- Nginx ログのオンライン閲覧機能もあるで。
103+
- Go と Vue で書かれとって、配布物は単一バイナリだからセットアップも簡単や。
104+
- 保存時に設定テスト→nginx 再読み込みまで自動でやってくれるで。
105+
- Web ターミナル
106+
- ダークモード対応
107+
- レスポンシブデザイン
108+
109+
### 多言語化
110+
111+
公式でサポートしてんのは:
112+
- 英語
113+
- 簡体字中国語
114+
- 繁體字中国語
115+
116+
117+
非ネイティブの英語話者やから完璧ちゃうかもしれへんけど、気づいたことあったらフィードバックしてや!
118+
119+
コミュニティのおかげで他の言語もいろいろ揃っとるで。翻訳に参加したい人は [Weblate](https://weblate.nginxui.com) 見てみてな。
120+
121+
### 主要技術
122+
123+
- [Go言語](https://go.dev)
124+
- [Gin Web Framework](https://gin-gonic.com)
125+
- [GORM](http://gorm.io)
126+
- [Vue 3](https://v3.vuejs.org)
127+
- [Vite](https://vitejs.dev)
128+
- [TypeScript](https://www.typescriptlang.org/)
129+
- [Ant Design Vue](https://antdv.com)
130+
- [vue3-gettext](https://github.com/jshmrtn/vue3-gettext)
131+
- [vue3-ace-editor](https://github.com/CarterLi/vue3-ace-editor)
132+
- [Gonginx](https://github.com/tufanbarisyildirim/gonginx)
133+
- [lego](https://github.com/go-acme/lego)
134+
135+
## はじめに
136+
137+
### 使用前の注意
138+
139+
Nginx UIはDebian系Webサーバ設定ファイルの標準に準拠します。
140+
作成されたサイト設定ファイルは、自動検出されたNginx設定フォルダ内の`sites-available`に配置されます。有効化されたサイトは`sites-enabled`にシンボリックリンクが作成されます。
141+
142+
非Debian系(Ubuntu以外)の場合は、以下のように`nginx.conf`をDebianスタイルに変更してください。
143+
144+
```nginx
145+
http {
146+
# ...
147+
include /etc/nginx/conf.d/*.conf;
148+
include /etc/nginx/sites-enabled/*;
149+
}
150+
```
151+
152+
詳細: [debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/master/debian/conf/nginx.conf#L59-L60)
153+
154+
### インストール
155+
156+
Nginx UIは以下のプラットフォームで利用可能です:
157+
158+
- macOS 11 Big Sur and later (amd64 / arm64)
159+
- Windows 10 and later (amd64 / arm64)
160+
- Linux 2.6.23 and later (x86 / amd64 / arm64 / armv5 / armv6 / armv7 / mips32 / mips64 / riscv64 / loongarch64)
161+
- Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 6 / 7, Arch Linux
162+
- FreeBSD
163+
- OpenBSD
164+
- Dragonfly BSD
165+
- Openwrt
166+
167+
168+
最新リリースは[リリースページ](https://github.com/0xJacky/nginx-ui/releases/latest)からダウンロード、または[Linux用インストールスクリプト](#script-for-linux)を利用
169+
170+
171+
### 使い方
172+
173+
初回起動後、ブラウザで`http://<your_server_ip>:<listen_port>`にアクセスし、初期設定を完了してください。
174+
175+
#### 実行ファイルから
176+
**ターミナルでNginx UIを動かす**
177+
178+
```shell
179+
nginx-ui -config app.ini
180+
```
181+
`Control+C`で終了します。
182+
183+
**バックグラウンドでNginx UIを動かす**
184+
185+
```shell
186+
nohup ./nginx-ui -config app.ini &
187+
```
188+
以下のコマンドでNginx UIを停止する。
189+
190+
```shell
191+
kill -9 $(ps -aux | grep nginx-ui | grep -v grep | awk '{print $2}')
192+
```
193+
194+
#### Systemdで
195+
[Linuxインストールスクリプト](#script-for-linux)を使うと、`nginx-ui`というsystemdサービスが作成されます。以下コマンドで操作可能:
196+
197+
**起動**
198+
199+
```shell
200+
systemctl start nginx-ui
201+
```
202+
**停止**
203+
204+
```shell
205+
systemctl stop nginx-ui
206+
```
207+
**再起動**
208+
209+
```shell
210+
systemctl restart nginx-ui
211+
```
212+
213+
#### Dockerで
214+
公式イメージ [uozi/nginx-ui:latest](https://hub.docker.com/r/uozi/nginx-ui) はベースに公式 nginx イメージを利用しています。ホストの Nginx と置き換える形で利用可能です。
215+
216+
##### 注意
217+
1. 初回利用時は `/etc/nginx` にマッピングするボリュームが空であることを確認してください。
218+
2. 静的ファイルを配信する場合は、適切なディレクトリをマッピングしてください。
219+
220+
<details>
221+
<summary><b>Dockerでデプロイ</b></summary>
222+
223+
1. [Dockerをインストール](https://docs.docker.com/install/)
224+
225+
2. 以下のように実行:
226+
227+
```bash
228+
docker run -dit \
229+
--name=nginx-ui \
230+
--restart=always \
231+
-e TZ=Asia/Shanghai \
232+
-v /mnt/user/appdata/nginx:/etc/nginx \
233+
-v /mnt/user/appdata/nginx-ui:/etc/nginx-ui \
234+
-v /var/run/docker.sock:/var/run/docker.sock \
235+
-p 8080:80 -p 8443:443 \
236+
uozi/nginx-ui:latest
237+
```
238+
239+
3. パネルには `[http://<your-ip>:8080/install](http://<your_server_ip>:8080/install)` でアクセスします。
240+
</details>
241+
242+
<details>
243+
<summary><b>Docker-Composeでデプロイ</b></summary>
244+
245+
1. [Docker-Composeをインストール](https://docs.docker.com/compose/install/)
246+
247+
2. 以下内容の`docker-compose.yml`を作成:
248+
249+
```yml
250+
services:
251+
nginx-ui:
252+
stdin_open: true
253+
tty: true
254+
container_name: nginx-ui
255+
restart: always
256+
environment:
257+
- TZ=Asia/Shanghai
258+
volumes:
259+
- '/mnt/user/appdata/nginx:/etc/nginx'
260+
- '/mnt/user/appdata/nginx-ui:/etc/nginx-ui'
261+
- '/var/www:/var/www'
262+
- '/var/run/docker.sock:/var/run/docker.sock'
263+
ports:
264+
- 8080:80
265+
- 8443:443
266+
image: 'uozi/nginx-ui:latest'
267+
```
268+
269+
3. コンテナの起動:
270+
```bash
271+
docker compose up -d
272+
```
273+
274+
4. パネルには `[http://<your-ip>:8080/install](http://<your_server_ip>:8080/install)` でアクセスします。
275+
276+
</details>
277+
278+
## 手動ビルド
279+
280+
公式ビルドがないプラットフォーム向けに、以下の手順でビルドできます。
281+
282+
### 前提条件
283+
284+
- Make
285+
286+
- Golang 1.23+
287+
288+
- node.js 21+
289+
290+
```shell
291+
npx browserslist@latest --update-db
292+
```
293+
294+
### フロントエンドのビルド
295+
296+
`app` ディレクトリで以下を実行:
297+
298+
```shell
299+
pnpm install
300+
pnpm build
301+
```
302+
303+
### バックエンドのビルド
304+
305+
フロントエンドビルド後、プロジェクトルートで:
306+
307+
```shell
308+
go generate
309+
go build -tags=jsoniter -ldflags "$LD_FLAGS -X 'github.com/0xJacky/Nginx-UI/settings.buildTime=$(date +%s)'" -o nginx-ui -v main.go
310+
```
311+
312+
## Linux用スクリプト
313+
314+
### 基本的な使い方
315+
316+
**インストール & アップグレード**
317+
318+
```shell
319+
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install
320+
```
321+
デフォルトのリスニングポートは `9000`、HTTP チャレンジポートは `9180` です。
322+
競合する場合は `/usr/local/etc/nginx-ui/app.ini` を編集し、`systemctl restart nginx-ui` を実行してください。
323+
324+
**設定・DB を残してアンインストール**
325+
326+
```shell
327+
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove
328+
```
329+
330+
### その他の使い方
331+
332+
````shell
333+
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ help
334+
````
335+
336+
## Nginx リバースプロキシ設定例
337+
338+
```nginx
339+
server {
340+
listen 80;
341+
listen [::]:80;
342+
343+
server_name <your_server_name>;
344+
rewrite ^(.*)$ https://$host$1 permanent;
345+
}
346+
347+
map $http_upgrade $connection_upgrade {
348+
default upgrade;
349+
'' close;
350+
}
351+
352+
server {
353+
listen 443 ssl;
354+
listen [::]:443 ssl;
355+
http2 on;
356+
357+
server_name <your_server_name>;
358+
359+
ssl_certificate /path/to/ssl_cert;
360+
ssl_certificate_key /path/to/ssl_cert_key;
361+
362+
location / {
363+
proxy_set_header Host $host;
364+
proxy_set_header X-Real-IP $remote_addr;
365+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
366+
proxy_set_header X-Forwarded-Proto $scheme;
367+
proxy_http_version 1.1;
368+
proxy_set_header Upgrade $http_upgrade;
369+
proxy_set_header Connection $connection_upgrade;
370+
proxy_pass http://127.0.0.1:9000/;
371+
}
372+
}
373+
```
374+
375+
## 貢献方法
376+
377+
オープンソースコミュニティへの貢献は**大歓迎**です。
378+
改善提案がある場合はリポジトリをフォークし、プルリクエストを作成してください。
379+
Issueに「enhancement」タグをつけて提案することもできます。
380+
スターもよろしくお願いします!
381+
382+
1. リポジトリをフォーク
383+
2. フィーチャーブランチ作成 (`git checkout -b feature/AmazingFeature`)
384+
3. 変更をコミット (`git commit -m 'Add some AmazingFeature'`)
385+
4. ブランチをプッシュ (`git push origin feature/AmazingFeature`)
386+
5. プルリクエストを作成
387+
388+
## ライセンス
389+
390+
本プロジェクトは GNU Affero General Public License v3.0 に基づき配布されています。ライセンスの詳細は [LICENSE](LICENSE) ファイルをご覧ください。

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To check out docs, visit [nginxui.com](https://nginxui.com).
3030

3131
[![Stargazers over time](https://starchart.cc/0xJacky/nginx-ui.svg)](https://starchart.cc/0xJacky/nginx-ui)
3232

33-
English | [Español](README-es.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md) | [Tiếng Việt](README-vi_VN.md)
33+
English | [Español](README-es.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md) | [Tiếng Việt](README-vi_VN.md) | [日本語](README-ja_JP.md)
3434

3535
<details>
3636
<summary>Table of Contents</summary>

0 commit comments

Comments
 (0)