mirror of
https://github.com/baoweise-bot/aimili-vpngate.git
synced 2026-09-06 08:07:04 +08:00
docs: redesign readme and add translations
This commit is contained in:
Aimili
@@ -0,0 +1,235 @@
|
||||
<div align="center">
|
||||
|
||||
# AimiliVPN
|
||||
|
||||
**Linux VPS 向け VPNGate ノード管理・HTTP / HTTPS / SOCKS5 プロキシゲートウェイ**
|
||||
|
||||
[](https://github.com/baoweise-bot/aimili-vpngate/releases/latest)
|
||||
[](https://github.com/baoweise-bot/aimili-vpngate/pkgs/container/aimili-vpngate)
|
||||
[](../LICENSE)
|
||||
|
||||
[简体中文](../README.md) · [English](README.en.md) · **日本語** · [한국어](README.ko.md)
|
||||
|
||||
[クイックインストール](#quick-install) · [インストール](#installation) · [接続方法](#connection) · [VPS](#vps) · [コミュニティ](#community) · [法的通知](#legal)
|
||||
|
||||
[](https://339936.xyz)
|
||||
[](https://t.me/arestemple)
|
||||
[](https://www.youtube.com/watch?v=s-ATfXR8BpI)
|
||||
|
||||
</div>
|
||||
|
||||
AimiliVPN は Python 標準ライブラリで VPNGate ノードを管理し、ノード取得・テスト、接続切り替え、Web 管理画面、HTTP / HTTPS サイト用プロキシと SOCKS5 を提供します。
|
||||
|
||||
| 項目 | デフォルトまたは対応範囲 |
|
||||
| --- | --- |
|
||||
| Web 管理画面 | TCP `8787`、専用パス、ユーザー名、パスワード |
|
||||
| ローカルプロキシ | `127.0.0.1:7928`、HTTP、HTTPS `CONNECT`、SOCKS5 |
|
||||
| ソース版 | x64、x86、ARM64、ARM32 Linux |
|
||||
| Docker | `linux/amd64`、`linux/386`、`linux/arm64`、`linux/arm/v7` |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **地域に関する注意：** 中国本土のデータセンターにある VPS では、現地のネットワークポリシー、事業者の制限、DNS、VPNGate API、VPN プロトコルの制限により、ノード取得や接続ができない場合があります。ミラーやローカルスナップショットがあっても利用可能性は保証されません。本プロジェクトは中国本土での展開を対象としていません。中国本土外で、現地法および VPS 事業者が VPN/TUN を明示的に許可している環境でのみ使用してください。
|
||||
|
||||
<a id="quick-install"></a>
|
||||
## クイックインストール
|
||||
|
||||
対応する Linux VPS で `root` として実行します。
|
||||
|
||||
```bash
|
||||
bash <(curl -Ls https://raw.githubusercontent.com/baoweise-bot/aimili-vpngate/main/install.sh)
|
||||
```
|
||||
|
||||
完了後、Web 管理画面の URL、専用パス、ユーザー名、パスワードが表示されます。`ml` で管理メニューを開けます。
|
||||
|
||||
> [!TIP]
|
||||
> VPS の管理画面で TUN/TAP を有効にし、`/dev/net/tun` が存在することを確認してください。Web のデフォルトポートは TCP `8787` です。可能な限り自分の IP だけを許可してください。
|
||||
|
||||
<a id="vps"></a>
|
||||
## VPS の案内
|
||||
|
||||
以下はアフィリエイトリンクです。リンク経由でも購入価格は上がりません。
|
||||
|
||||
| プロバイダー | 用途 | 特長 | リンク |
|
||||
| --- | --- | --- | --- |
|
||||
| **BandwagonHost** | 経路品質、遅延、長期安定性を重視 | 高品質な国際回線を必要とする用途向け | [BandwagonHost](https://bandwagonhost.com/aff.php?aff=81790) |
|
||||
| **RackNerd** | 低コストの導入、テスト、常時稼働 | 比較的低価格で大容量の転送量 | [RackNerd](https://my.racknerd.com/aff.php?aff=18708) |
|
||||
|
||||
購入前に、データセンターが中国本土外にあり、TUN/TAP、OpenVPN、必要なプロトコルが許可されていることを確認してください。
|
||||
|
||||
<a id="installation"></a>
|
||||
## インストール
|
||||
|
||||
### 動作要件
|
||||
|
||||
- Ubuntu、Debian、Alpine、CentOS、RHEL、Rocky Linux、AlmaLinux、Fedora、Oracle Linux、Amazon Linux。
|
||||
- `root`、OpenVPN、iptables、ポリシールーティング、TUN/TAP。
|
||||
- Windows と macOS はプロキシクライアントとして利用できますが、ゲートウェイ本体は実行できません。
|
||||
|
||||
### 方法 1：ソースインストーラー
|
||||
|
||||
```bash
|
||||
bash <(curl -Ls https://raw.githubusercontent.com/baoweise-bot/aimili-vpngate/main/install.sh)
|
||||
```
|
||||
|
||||
`/opt/aimilivpn` に配置し、システムサービスを登録します。
|
||||
|
||||
```bash
|
||||
ml # 管理メニュー
|
||||
ml status # 状態、Web URL、ユーザー名
|
||||
ml logs # ログ
|
||||
ml restart # 再起動
|
||||
ml password # Web 認証情報を再設定
|
||||
ml update # main 安定版から更新
|
||||
ml uninstall # アンインストール
|
||||
```
|
||||
|
||||
事前にスクリプトを確認する場合：
|
||||
|
||||
```bash
|
||||
git clone --branch main --single-branch https://github.com/baoweise-bot/aimili-vpngate.git
|
||||
cd aimili-vpngate
|
||||
sudo bash install.sh
|
||||
```
|
||||
|
||||
Linux 共通ソースアーカイブと SHA-256 は [GitHub Releases](https://github.com/baoweise-bot/aimili-vpngate/releases/latest) から取得できます。変更内容は Release Notes に掲載されます。
|
||||
|
||||
### 方法 2：Docker Compose
|
||||
|
||||
Docker ホストには `/dev/net/tun`、host ネットワーク、`NET_ADMIN`、`NET_RAW` が必要です。
|
||||
|
||||
```bash
|
||||
git clone --branch main --single-branch https://github.com/baoweise-bot/aimili-vpngate.git
|
||||
cd aimili-vpngate
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
docker logs -f aimilivpn
|
||||
```
|
||||
|
||||
イメージ：`ghcr.io/baoweise-bot/aimili-vpngate:2.1`
|
||||
|
||||
更新：
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary><strong>docker run コマンドを表示</strong></summary>
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name aimilivpn \
|
||||
--restart unless-stopped \
|
||||
--network host \
|
||||
--cap-add NET_ADMIN \
|
||||
--cap-add NET_RAW \
|
||||
--device /dev/net/tun:/dev/net/tun \
|
||||
-e UI_HOST=0.0.0.0 \
|
||||
-e UI_PORT=8787 \
|
||||
-e LOCAL_PROXY_HOST=127.0.0.1 \
|
||||
-e LOCAL_PROXY_PORT=7928 \
|
||||
-v aimilivpn-data:/data \
|
||||
ghcr.io/baoweise-bot/aimili-vpngate:2.1
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>GHCR を利用できない場合のローカルビルド</strong></summary>
|
||||
|
||||
```bash
|
||||
git clone --branch main --single-branch https://github.com/baoweise-bot/aimili-vpngate.git
|
||||
cd aimili-vpngate
|
||||
docker compose build
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<a id="connection"></a>
|
||||
## 接続と利用方法
|
||||
|
||||
### 1. Web 管理画面へログイン
|
||||
|
||||
ソース版では、インストーラーが表示した URL を開きます。
|
||||
|
||||
```text
|
||||
http://VPS_IP:8787/private_path/
|
||||
```
|
||||
|
||||
URL は `ml status`、認証情報の再設定は `ml password` を使用します。Docker では次のコマンドで初期設定を確認できます。
|
||||
|
||||
```bash
|
||||
docker exec aimilivpn cat /data/ui_auth.json
|
||||
```
|
||||
|
||||
`secret_path`、`username`、`password` を使用し、初回ログイン後に変更してください。
|
||||
|
||||
### 2. ノードを取得して接続
|
||||
|
||||
1. ログイン後、最初の一覧を待つか「ノード更新」を実行します。
|
||||
2. 国で絞り込み、「テスト」で VPS からの到達性と遅延を確認します。
|
||||
3. 対象ノードの「切り替え」を選択します。事前確認に失敗した場合、可能な限り現在の接続を維持します。
|
||||
4. スマート自動、国固定、IP 固定からルーティングモードを選びます。
|
||||
5. 接続状態と出口 IP を確認します。
|
||||
|
||||
### 3. VPS 上でプロキシを使用
|
||||
|
||||
HTTP、HTTPS サイト用プロキシ、SOCKS5 は `127.0.0.1:7928` を共有します。
|
||||
|
||||
```bash
|
||||
# HTTP / HTTPS
|
||||
curl -x http://127.0.0.1:7928 https://api.ipify.org
|
||||
|
||||
# SOCKS5、DNS もプロキシ経由
|
||||
curl --proxy socks5h://127.0.0.1:7928 https://api.ipify.org
|
||||
```
|
||||
|
||||
### 4. 別の端末から接続
|
||||
|
||||
プロキシを公開せず、SSH トンネルを利用してください。
|
||||
|
||||
```bash
|
||||
ssh -N \
|
||||
-L 8787:127.0.0.1:8787 \
|
||||
-L 7928:127.0.0.1:7928 \
|
||||
root@VPS_IP
|
||||
```
|
||||
|
||||
- Web：`http://127.0.0.1:8787/private_path/`
|
||||
- HTTP / HTTPS：`127.0.0.1:7928`
|
||||
- SOCKS5：`127.0.0.1:7928`。可能な場合はリモート DNS または `socks5h` を使用
|
||||
|
||||
> [!WARNING]
|
||||
> `7928` には、デフォルトで公開用のユーザー認証がありません。ファイアウォール、接続元 IP 制限などの確実なアクセス制御なしで公開しないでください。
|
||||
|
||||
<a id="community"></a>
|
||||
## Web サイト・コミュニティ・動画
|
||||
|
||||
| 入口 | 用途 | リンク |
|
||||
| --- | --- | --- |
|
||||
| Web サイト / フォーラム | お知らせと交流 | [339936.xyz](https://339936.xyz) |
|
||||
| Telegram | リアルタイム交流 | [t.me/arestemple](https://t.me/arestemple) |
|
||||
| YouTube | インストール・利用方法 | [動画を見る](https://www.youtube.com/watch?v=s-ATfXR8BpI) |
|
||||
| GitHub Issues | 再現可能な不具合と機能要望 | [Issue を作成](https://github.com/baoweise-bot/aimili-vpngate/issues) |
|
||||
| メール | 不具合報告と連絡 | [yaohunse7@gmail.com](mailto:yaohunse7@gmail.com) |
|
||||
|
||||
<a id="legal"></a>
|
||||
## 利用範囲と法的通知
|
||||
|
||||
> [!CAUTION]
|
||||
> 本プロジェクトをダウンロード、展開、使用する前に、利用地と VPS 所在地の法律、事業者の規約、VPNGate の規則への適合を利用者自身で確認してください。本節は利用範囲を示すもので、法律上の助言ではなく、法的責任の免除を保証するものではありません。
|
||||
|
||||
1. **許可される用途：** 合法なネットワーク研究、教育、開発テスト、プライバシー保護、許可されたアクセスに限ります。法的な規制の回避、不正アクセス、攻撃、スキャン、スパム、詐欺、権利侵害、その他の違法行為に使用してはいけません。
|
||||
2. **地域制限：** 中国本土の VPS では VPNGate、GitHub ミラー、VPN ノードに接続できない場合があります。本プロジェクトは中国本土での可用性を保証・サポートせず、中国本土外で現地法が許可する場合の合理的な利用を対象とします。
|
||||
3. **第三者ノード：** VPNGate ノードは第三者のボランティアが運営しています。本プロジェクトはノードを所有・管理・監査せず、可用性、速度、安全性、プライバシー方針、ログ動作を保証しません。機密情報を信頼できないノードで送信しないでください。
|
||||
4. **利用者の責任：** ノード選択、通信内容、設置場所、公開ポート、アカウント管理は利用者の責任です。違法利用、設定不備、第三者ノード、停止、情報漏えい、不正利用に伴う責任は利用者が負います。
|
||||
5. **無保証：** 本ソフトウェアは「現状有姿」で提供されます。適用法で認められる最大限の範囲で、保守者は可用性、商品性、特定目的適合性、間接損害を保証しません。法律上排除できない責任には影響しません。
|
||||
6. **不明な場合：** 現地法や事業者規約で許可されているか確認できない場合は使用を中止し、該当法域の有資格法律専門家に相談してください。
|
||||
|
||||
<div align="center">
|
||||
|
||||
[Stable Release](https://github.com/baoweise-bot/aimili-vpngate/releases/latest) · [Issues](https://github.com/baoweise-bot/aimili-vpngate/issues) · [GPL-3.0 License](../LICENSE)
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user