Feat : Gitbook

This commit is contained in:
decolua
2026-05-11 11:50:24 +07:00
parent 7ad538bcf2
commit fd92af77a0
124 changed files with 34154 additions and 4 deletions

View File

@@ -0,0 +1,478 @@
# インストール
トラブルシューティングのヒント付きの9Router詳細インストールガイド。
---
## 要件
### システム要件
- **Node.js**: バージョン 20.0.0以上
- **npm**: バージョン 10.0.0以上 (Node.jsに付属)
- **OS**: macOS、Linux、Windows (WSL推奨)
- **ディスク容量**: インストールに約200MB
### バージョンを確認
```bash
node --version
# v20.x.x以上が表示されるはず
npm --version
# 10.x.x以上が表示されるはず
```
**Node.jsがない場合?** [nodejs.org](https://nodejs.org/)からインストール
---
## インストール方法
### 方法1: グローバルインストール (推奨)
どこからでも使用できるように9Routerをグローバルインストール:
```bash
npm install -g 9router
```
**9Routerを起動:**
```bash
9router
```
**利点:**
- ✅ どのディレクトリからでも実行
- ✅ シンプルなコマンド: `9router`
- ✅ `npm update -g 9router` で自動更新
### 方法2: ローカルインストール
特定のプロジェクトにインストール:
```bash
mkdir my-9router
cd my-9router
npm install 9router
```
**9Routerを起動:**
```bash
npx 9router
```
**利点:**
- ✅ プロジェクトごとに分離
- ✅ プロジェクトごとのバージョン管理
- ✅ グローバル名前空間の汚染なし
### 方法3: ソースから (開発)
GitHubからクローンしてビルド:
```bash
git clone https://github.com/decolua/9router.git
cd 9router/app
npm install
npm run build
npm start
```
**利点:**
- ✅ 最新の開発機能
- ✅ 開発に貢献可能
- ✅ カスタム変更
---
## 初回実行
### サーバーを起動
```bash
9router
```
**何が起こるか:**
1. サーバーが `http://localhost:20128` で起動
2. ダッシュボードが自動的にブラウザで開く
3. `~/.9router` にデータディレクトリが作成される
4. APIキーが自動生成される
### ダッシュボードログイン
**デフォルト認証情報:**
- パスワード: `123456`
**⚠️ パスワードをすぐに変更:**
1. ダッシュボードにログイン
2. Settings → Change Password
3. 強力なパスワードを使用
### APIキーを取得
```
Dashboard → Settings → API Keys
→ APIキーをコピー
→ CLIツールで使用
```
**APIキー形式の例:**
```
9r_1234567890abcdef1234567890abcdef
```
---
## インストールを確認
### サーバーステータスを確認
```bash
curl http://localhost:20128/health
```
**期待されるレスポンス:**
```json
{
"status": "ok",
"version": "1.0.0"
}
```
### 利用可能なモデルを一覧表示
```bash
curl http://localhost:20128/v1/models \
-H "Authorization: Bearer your-api-key"
```
**期待されるレスポンス:**
```json
{
"object": "list",
"data": [
{
"id": "cc/claude-opus-4-5-20251101",
"object": "model",
"created": 1234567890,
"owned_by": "claude-code"
}
]
}
```
### チャットコンプリーションをテスト
```bash
curl http://localhost:20128/v1/chat/completions \
-H "Authorization: Bearer your-api-key" \
-H "Content-Type: application/json" \
-d '{
"model": "cc/claude-opus-4-5-20251101",
"messages": [
{"role": "user", "content": "Hello!"}
]
}'
```
---
## 設定
### 環境変数
`.env` ファイルを作成するか、環境変数を設定:
```bash
# セキュリティ (本番環境では必須)
export JWT_SECRET="your-secure-secret-change-this"
export INITIAL_PASSWORD="your-password"
# ストレージ
export DATA_DIR="~/.9router"
# サーバー
export PORT="20128"
export NODE_ENV="production"
# ロギング
export ENABLE_REQUEST_LOGS="false"
```
### データディレクトリ
**デフォルトの場所:** `~/.9router`
**内容:**
```
~/.9router/
├── db.json # データベース (プロバイダー、コンボ、使用量)
├── api-keys.json # APIキー
└── logs/ # リクエストログ (有効化されている場合)
```
**場所を変更:**
```bash
export DATA_DIR="/custom/path"
9router
```
### ポート設定
**デフォルトポート:** `20128`
**ポートを変更:**
```bash
export PORT="3000"
9router
```
**またはコマンドラインで:**
```bash
9router --port 3000
```
---
## トラブルシューティング
### ポートがすでに使用されている
**エラー:**
```
Error: listen EADDRINUSE: address already in use :::20128
```
**解決策1: 既存のプロセスを終了**
```bash
# ポート20128を使用しているプロセスを検索
lsof -i :20128
# プロセスを終了
kill -9 <PID>
```
**解決策2: 別のポートを使用**
```bash
9router --port 3000
```
### Permission Denied
**エラー:**
```
Error: EACCES: permission denied, mkdir '/usr/local/lib/node_modules/9router'
```
**解決策: sudoを使用 (非推奨) またはnpm権限を修正**
```bash
# npm権限を修正 (推奨)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
# 再度インストール
npm install -g 9router
```
### Node.jsバージョンが古すぎる
**エラー:**
```
Error: The engine "node" is incompatible with this module
```
**解決策: Node.jsを更新**
```bash
# nvmを使用 (推奨)
nvm install 20
nvm use 20
# またはnodejs.orgからダウンロード
```
### ダッシュボードが開かない
**問題:** ダッシュボードが自動的に開かない
**解決策1: 手動で開く**
```
http://localhost:20128
```
**解決策2: ファイアウォールを確認**
```bash
# macOS: システム環境設定 → セキュリティでNode.jsを許可
# Linux: iptablesを確認
# Windows: Windowsファイアウォールを確認
```
### プロバイダーに接続できない
**問題:** OAuthログインが失敗、またはAPIキーが無効
**解決策1: インターネット接続を確認**
```bash
ping google.com
```
**解決策2: プロバイダーのステータスを確認**
- Claude Code: [status.anthropic.com](https://status.anthropic.com)
- OpenAI: [status.openai.com](https://status.openai.com)
- Gemini: [status.cloud.google.com](https://status.cloud.google.com)
**解決策3: APIキーを再生成**
```
Dashboard → Provider → Disconnect → Reconnect
```
### 高メモリ使用量
**問題:** 9RouterがRAMを使いすぎている
**解決策: サーバーを再起動**
```bash
# 停止
pkill -f 9router
# 起動
9router
```
**または自動再起動にPM2を使用:**
```bash
npm install -g pm2
pm2 start 9router --name 9router
pm2 save
```
---
## デプロイメントオプション
### ローカル開発
```bash
npm install -g 9router
9router
```
**ユースケース:** 個人コーディング、テスト
### VPS/クラウドサーバー
```bash
# インストール
npm install -g 9router
# 設定
export JWT_SECRET="your-secure-secret"
export INITIAL_PASSWORD="your-password"
export NODE_ENV="production"
# PM2で起動
npm install -g pm2
pm2 start 9router --name 9router
pm2 save
pm2 startup
```
**ユースケース:** チームアクセス、リモートコーディング
### Docker
```bash
docker pull 9router/9router:latest
docker run -d \
-p 20128:20128 \
-e JWT_SECRET="your-secure-secret" \
-e INITIAL_PASSWORD="your-password" \
-v 9router-data:/root/.9router \
--name 9router \
9router/9router:latest
```
**ユースケース:** コンテナデプロイ、Kubernetes
### リバースプロキシ (Nginx)
```nginx
server {
listen 80;
server_name your-domain.com;
location / {
proxy_pass http://localhost:20128;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
# SSE support for streaming
proxy_buffering off;
proxy_read_timeout 86400;
}
}
```
**ユースケース:** HTTPS、カスタムドメイン、ロードバランシング
---
## アンインストール
### グローバルインストールを削除
```bash
npm uninstall -g 9router
```
### データディレクトリを削除
```bash
rm -rf ~/.9router
```
### 設定を削除
```bash
# シェル設定から環境変数を削除
nano ~/.bashrc # または ~/.zshrc
# 9router関連のエクスポートを削除
```
---
## 次のステップ
- [スタートガイド](../getting-started.md) - プロバイダーを接続してコーディング開始
- [機能](../features/) - クォータトラッキング、コンボ、デプロイを確認
- [トラブルシューティング](../troubleshooting.md) - 一般的な問題の修正
---
## ヘルプが必要?
- **ウェブサイト**: [9router.com](https://9router.com)
- **GitHub**: [github.com/decolua/9router](https://github.com/decolua/9router)
- **Issues**: [github.com/decolua/9router/issues](https://github.com/decolua/9router/issues)

View File

@@ -0,0 +1,247 @@
# はじめに
9Routerを5分で起動し、AIリクエストをインテリジェントにルーティングし始めましょう。
---
## クイックスタート
### 1. インストール
```bash
npm install -g 9router
```
**要件:** Node.js 20+ ([インストール詳細](getting-started/installation.md))
### 2. 起動
```bash
9router
```
🎉 **ダッシュボードが自動的に開きます** (`http://localhost:20128`)
- デフォルトパスワード: `123456` (ダッシュボードで変更)
- APIキーは自動生成
- プロバイダー接続の準備完了
### 3. プロバイダーを接続
プロバイダーを接続する方法は3つあります:
#### オプションA: OAuth(サブスクリプションプロバイダー)
**最適:** Claude Code、Codex、Gemini CLI、GitHub Copilot
```
Dashboard → Providers → Connect [Provider]
→ OAuthログイン → トークン自動更新
→ クォータトラッキング有効化
```
**例: Claude Code**
1. 「Connect Claude Code」をクリック
2. Claudeアカウントでログイン
3. 9Routerを認可
4. ✅ 完了! モデルを使用: `cc/claude-opus-4-5-20251101`
#### オプションB: APIキー(低価格プロバイダー)
**最適:** GLM、MiniMax、Kimi、OpenRouter
```
Dashboard → Providers → Add API Key
→ プロバイダーを選択
→ APIキーを貼り付け
→ 保存
```
**例: GLM-4.7**
1. [Zhipu AI](https://open.bigmodel.cn/)でサインアップ
2. Coding PlanからAPIキーを取得
3. Dashboard → Add API Key → Provider: `glm` → キーを貼り付け
4. ✅ 完了! モデルを使用: `glm/glm-4.7`
#### オプションC: 無料プロバイダー(コストなし)
**最適:** iFlow、Qwen、Kiro
```
Dashboard → Providers → Connect [Free Provider]
→ デバイスコードまたはOAuth
→ 無制限利用
```
**例: iFlow**
1. 「Connect iFlow」をクリック
2. iFlowアカウントでログイン
3. 認可
4. ✅ 完了! 8モデルを使用: `if/kimi-k2-thinking`、`if/qwen3-coder-plus`など
---
## 4. CLIツールで使用
コーディングツールを9Routerに向けます:
### Cursor IDE
```
Settings → Models → Advanced:
OpenAI API Base URL: http://localhost:20128/v1
OpenAI API Key: [9routerダッシュボードから取得]
Model: cc/claude-opus-4-5-20251101
```
### Claude Desktop
`~/.claude/config.json`を編集:
```json
{
"anthropic_api_base": "http://localhost:20128/v1",
"anthropic_api_key": "your-9router-api-key"
}
```
### Cline / Continue / RooCode
```
Provider: OpenAI Compatible
Base URL: http://localhost:20128/v1
API Key: [ダッシュボードから取得]
Model: cc/claude-opus-4-5-20251101
```
### Codex CLI
```bash
export OPENAI_BASE_URL="http://localhost:20128"
export OPENAI_API_KEY="your-9router-api-key"
codex "your prompt"
```
---
## 5. スマートコンボを作成(オプション)
コンボはモデル間の自動フォールバックを可能にします:
```
Dashboard → Combos → Create New
Name: premium-coding
Models:
1. cc/claude-opus-4-5-20251101 (サブスクリプション優先)
2. glm/glm-4.7 (低価格バックアップ、100万あたり$0.6)
3. if/kimi-k2-thinking (無料フォールバック)
CLIで使用: premium-coding
```
**動作:**
1. 最初にClaude Opusを試行(サブスクリプション)
2. クォータ消費時 → GLM-4.7(超低価格)
3. 予算上限時 → iFlow(無料)
4. ダウンタイムゼロ、自動切替!
---
## 利用可能なモデル
### サブスクリプションモデル(最初に最大化)
**Claude Code (`cc/`)** - Pro/Maxサブスクリプション:
- `cc/claude-opus-4-5-20251101` - Claude 4.5 Opus
- `cc/claude-sonnet-4-5-20250929` - Claude 4.5 Sonnet
- `cc/claude-haiku-4-5-20251001` - Claude 4.5 Haiku
**Codex (`cx/`)** - Plus/Proサブスクリプション:
- `cx/gpt-5.2-codex` - GPT 5.2 Codex
- `cx/gpt-5.1-codex-max` - GPT 5.1 Codex Max
**Gemini CLI (`gc/`)** - 月18万無料:
- `gc/gemini-3-flash-preview` - Gemini 3 Flash Preview
- `gc/gemini-2.5-pro` - Gemini 2.5 Pro
**GitHub Copilot (`gh/`)** - サブスクリプション:
- `gh/gpt-5` - GPT-5
- `gh/claude-4.5-sonnet` - Claude 4.5 Sonnet
### 低価格モデル(バックアップ)
**GLM (`glm/`)** - 100万あたり$0.6/$2.2:
- `glm/glm-4.7` - GLM 4.7(毎日午前10時リセット)
**MiniMax (`minimax/`)** - 100万あたり$0.20/$1.00:
- `minimax/MiniMax-M2.1` - MiniMax M2.1(5時間リセット)
**Kimi (`kimi/`)** - 月$9(1000万トークン):
- `kimi/kimi-latest` - Kimi Latest
### 無料モデル(緊急時)
**iFlow (`if/`)** - 8モデル無料:
- `if/kimi-k2-thinking` - Kimi K2 Thinking
- `if/qwen3-coder-plus` - Qwen3 Coder Plus
- `if/glm-4.7` - GLM 4.7
- `if/deepseek-r1` - DeepSeek R1
**Qwen (`qw/`)** - 3モデル無料:
- `qw/qwen3-coder-plus` - Qwen3 Coder Plus
- `qw/qwen3-coder-flash` - Qwen3 Coder Flash
**Kiro (`kr/`)** - 2モデル無料:
- `kr/claude-sonnet-4.5` - Claude Sonnet 4.5
- `kr/claude-haiku-4.5` - Claude Haiku 4.5
---
## コスト最適化戦略
### 月予算: $10〜20/月
```
1. クイックタスクにGemini CLI無料プラン(月18万)を使用
2. Claude Codeサブスクリプションのクォータを完全利用(すでに支払い済み)
3. クォータ切れ時はGLM(100万あたり$0.6)へフォールバック
4. 緊急時: MiniMax M2.1(100万あたり$0.20)またはiFlow(無料)
実例(月1億トークン):
Gemini CLI経由で6000万: $0(無料プラン)
Claude Code経由で3000万: $0(既存サブスクリプション)
GLM経由で800万: $4.80
MiniMax経由で200万: $0.40
合計: 月$5.20 + 既存サブスクリプション
```
### クォータリセット戦略
```
日課:
1. 朝: Claude Codeの新しいクォータ(5時間リセット)
2. 午後: Gemini CLIへ切替(1K/日)
3. 夕方: GLM日次クォータ(翌朝10時リセット)
4. 深夜: MiniMax(5時間ローリング)またはiFlow(無料)
→ 最小の追加コストで24時間コーディング!
```
---
## 次のステップ
- [インストール詳細](getting-started/installation.md) - 要件、トラブルシューティング
- [機能](features/) - クォータトラッキング、コンボ、デプロイを確認
- [FAQ](faq.md) - よくある質問と回答
- [トラブルシューティング](troubleshooting.md) - 一般的な問題の修正
---
## ヘルプが必要?
- **ウェブサイト**: [9router.com](https://9router.com)
- **GitHub**: [github.com/decolua/9router](https://github.com/decolua/9router)
- **Issues**: [github.com/decolua/9router/issues](https://github.com/decolua/9router/issues)