resources/readme/README-ja_JP.md
もう一つのNginx Web UI 0xJacky, Hintay, Akinoによって開発されました。
公式ドキュメントは nginxui.com を参照してください。
English | Español | 简体中文 | 繁體中文 | Tiếng Việt | 日本語
<details> <summary>目次</summary> <ol> <li> <a href="#about-the-project">プロジェクトについて</a> <ul> <li><a href="#demo">デモ</a></li> <li><a href="#features">機能</a></li> <li><a href="#internationalization">多言語化</a></li> </ul> </li> <li> <a href="#getting-started">はじめに</a> <ul> <li><a href="#before-use">使用前の注意</a></li> <li><a href="#installation">インストール</a></li> <li> <a href="#usage">使い方</a> <ul> <li><a href="#from-executable">実行ファイルから</a></li> <li><a href="#with-systemd">Systemdで</a></li> <li><a href="#with-docker">Dockerで</a></li> </ul> </li> </ul> </li> <li> <a href="#manual-build">手動ビルド</a> <ul> <li><a href="#prerequisites">前提条件</a></li> <li><a href="#build-app">フロントエンドのビルド</a></li> <li><a href="#build-backend">バックエンドのビルド</a></li> </ul> </li> <li> <a href="#script-for-linux">Linux用スクリプト</a> <ul> <li><a href="#basic-usage">基本的な使い方</a></li> <li><a href="#more-usage">その他の使い方</a></li> </ul> </li> <li><a href="#example-of-nginx-reverse-proxy-configuration">Nginx リバースプロキシ設定例</a></li> <li><a href="#contributing">貢献方法</a></li> <li><a href="#license">ライセンス</a></li> </ol> </details>下記の言語を公式でサポートしています:
非ネイティブによる翻訳のため、不自然な表現が含まれている可能性があります。
お気づきの点がございましたら、ぜひフィードバックをお寄せください。
コミュニティのご協力により、他の言語の翻訳も多数提供されています。
翻訳にご参加いただける方は、Weblate をご覧ください。
Nginx UI は、Debian 系 Web サーバーの設定ファイル構成標準に準拠しています。
作成されたサイト設定ファイルは、自動的に検出された Nginx の設定ディレクトリ内の sites-available に配置されます。
有効化されたサイトについては、sites-enabled にシンボリックリンクが作成されます。
Debian 系以外のディストリビューション(Ubuntu を除く)を使用している場合は、以下の例を参考に nginx.conf を Debian スタイルの構成に変更してください。
http {
# ...
include /etc/nginx/conf.d/*.conf;
include /etc/nginx/sites-enabled/*;
}
Nginx UI は以下のプラットフォームで利用可能です:
最新リリースはリリースページからダウンロード、またはLinux用インストールスクリプトを利用
初回起動後、ブラウザでhttp://<your_server_ip>:<listen_port>にアクセスし、初期設定を完了してください。
ターミナルでNginx UIを動かす
nginx-ui -config app.ini
Control+Cで終了します。
バックグラウンドでNginx UIを動かす
nohup ./nginx-ui -config app.ini &
以下のコマンドで Nginx UI を停止します。
kill -9 $(ps -aux | grep nginx-ui | grep -v grep | awk '{print $2}')
Linuxインストールスクリプトを使うと、nginx-uiというsystemdサービスが作成されます。以下コマンドで操作可能:
起動
systemctl start nginx-ui
停止
systemctl stop nginx-ui
再起動
systemctl restart nginx-ui
公式イメージ uozi/nginx-ui:latest はベースに公式 nginx イメージを利用しています。ホストの Nginx と置き換える形で利用可能です。
/etc/nginx にマッピングするボリュームが空であることを確認してください。以下のように実行:
docker run -dit \
--name=nginx-ui \
--restart=always \
-e TZ=Asia/Shanghai \
-v /mnt/user/appdata/nginx:/etc/nginx \
-v /mnt/user/appdata/nginx-ui:/etc/nginx-ui \
-v /var/run/docker.sock:/var/run/docker.sock \
-p 8080:80 -p 8443:443 \
uozi/nginx-ui:latest
[http://<your-ip>:8080/install](http://<your_server_ip>:8080/install) でアクセスします。以下内容のdocker-compose.ymlを作成:
services:
nginx-ui:
stdin_open: true
tty: true
container_name: nginx-ui
restart: always
environment:
- TZ=Asia/Shanghai
volumes:
- '/mnt/user/appdata/nginx:/etc/nginx'
- '/mnt/user/appdata/nginx-ui:/etc/nginx-ui'
- '/var/www:/var/www'
- '/var/run/docker.sock:/var/run/docker.sock'
ports:
- 8080:80
- 8443:443
image: 'uozi/nginx-ui:latest'
docker compose up -d
[http://<your-ip>:8080/install](http://<your_server_ip>:8080/install) でアクセスします。公式ビルドがないプラットフォーム向けに、以下の手順でビルドできます。
Make
Golang 1.23+
node.js 21+
npx browserslist@latest --update-db
app ディレクトリで以下を実行:
pnpm install
pnpm build
フロントエンドビルド後、プロジェクトルートで:
go generate
go build -tags=jsoniter -ldflags "$LD_FLAGS -X 'github.com/0xJacky/Nginx-UI/settings.buildTime=$(date +%s)'" -o nginx-ui -v main.go
インストール & アップグレード
bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ install
デフォルトのリスニングポートは 9000、HTTP チャレンジ用ポートは 9180 です。
ポートが競合する場合は /usr/local/etc/nginx-ui/app.ini を編集し、systemctl restart nginx-ui を実行してください。
設定・DB を残してアンインストール
bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ remove
bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ help
server {
listen 80;
listen [::]:80;
server_name <your_server_name>;
rewrite ^(.*)$ https://$host$1 permanent;
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server {
listen 443 ssl;
listen [::]:443 ssl;
http2 on;
server_name <your_server_name>;
ssl_certificate /path/to/ssl_cert;
ssl_certificate_key /path/to/ssl_cert_key;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_pass http://127.0.0.1:9000/;
}
}
オープンソースコミュニティへの貢献は 大歓迎 です。
改善提案がある場合は、リポジトリをフォークし、プルリクエストを作成してください。
Issue に「enhancement」タグを付けて提案することもできます。
スターもぜひお願いします。
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)Nginx UI 公式 WeChat コミュニティグループへぜひご参加ください。利用方法、デプロイ構成、トラブルシューティングについて他のユーザーと交流できます。
以下の QR コードを WeChat で読み取り、申請時に Nginx UI Community Group と記載してください。管理者が公式コミュニティグループへ招待します。
本プロジェクトは GNU Affero General Public License v3.0 に基づき配布されています。ライセンスの詳細は LICENSE ファイルをご覧ください。