|
1 | 1 | # Schnellstart |
2 | 2 |
|
3 | | -## MCP Gateway einrichten |
| 3 | +## Ein-Klick-Bereitstellung von MCP Gateway |
4 | 4 |
|
5 | | -1. Erstellen Sie die erforderlichen Verzeichnisse und laden Sie die Konfigurationsdateien herunter: |
| 5 | +Zuerst die erforderlichen Umgebungsvariablen einrichten: |
6 | 6 |
|
7 | 7 | ```bash |
8 | | -mkdir -p mcp-gateway/{configs,data} |
9 | | -cd mcp-gateway/ |
10 | | -curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/configs/apiserver.yaml -o configs/apiserver.yaml |
11 | | -curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/configs/mcp-gateway.yaml -o configs/mcp-gateway.yaml |
12 | | -curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/.env.example -o .env.allinone |
| 8 | +export OPENAI_API_KEY="sk-eed837fb0b4a62ee69abc29a983492b7PlsChangeMe" |
| 9 | +export OPENAI_MODEL="gpt-4o-mini" |
| 10 | +export APISERVER_JWT_SECRET_KEY="fec6d38f73d4211318e7c85617f0e333PlsChangeMe" |
| 11 | +export SUPER_ADMIN_USERNAME="admin" |
| 12 | +export SUPER_ADMIN_PASSWORD="297df52fbc321ebf7198d497fe1c9206PlsChangeMe" |
| 13 | +``` |
| 14 | + |
| 15 | +Ein-Klick-Bereitstellung: |
| 16 | + |
| 17 | +```bash |
| 18 | +docker run -d \ |
| 19 | + --name mcp-gateway \ |
| 20 | + -p 8080:80 \ |
| 21 | + -p 5234:5234 \ |
| 22 | + -p 5235:5235 \ |
| 23 | + -p 5335:5335 \ |
| 24 | + -p 5236:5236 \ |
| 25 | + -e ENV=production \ |
| 26 | + -e TZ=Asia/Shanghai \ |
| 27 | + -e OPENAI_API_KEY=${OPENAI_API_KEY} \ |
| 28 | + -e OPENAI_MODEL=${OPENAI_MODEL} \ |
| 29 | + -e APISERVER_JWT_SECRET_KEY=${APISERVER_JWT_SECRET_KEY} \ |
| 30 | + -e SUPER_ADMIN_USERNAME=${SUPER_ADMIN_USERNAME} \ |
| 31 | + -e SUPER_ADMIN_PASSWORD=${SUPER_ADMIN_PASSWORD} \ |
| 32 | + --restart unless-stopped \ |
| 33 | + ghcr.io/mcp-ecosystem/mcp-gateway/allinone:latest |
13 | 34 | ``` |
14 | 35 |
|
15 | | -> Wenn Sie sich in China befinden, können Sie das Image aus dem Alibaba Cloud Registry beziehen: |
16 | | -> |
17 | | -> ```bash |
18 | | -> registry.ap-southeast-1.aliyuncs.com/mcp-ecosystem/mcp-gateway-allinone:latest |
19 | | -> ``` |
| 36 | +Für Benutzer in China können Sie das Alibaba Cloud Registry verwenden und das Modell anpassen (Beispiel mit Qwen): |
20 | 37 |
|
21 | | -> Bei Bedarf können Sie das Standard-LLM ersetzen. Zum Beispiel für den Wechsel zu Qwen: |
22 | | -> ```bash |
23 | | -> OPENAI_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1/ |
24 | | -> OPENAI_API_KEY=sk-yourkeyhere |
25 | | -> OPENAI_MODEL=qwen-turbo |
26 | | -> ``` |
| 38 | +```bash |
| 39 | +export OPENAI_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1/" |
| 40 | +export OPENAI_API_KEY="sk-eed837fb0b4a62ee69abc29a983492b7PlsChangeMe" |
| 41 | +export OPENAI_MODEL="qwen-turbo" |
| 42 | +export APISERVER_JWT_SECRET_KEY="fec6d38f73d4211318e7c85617f0e333PlsChangeMe" |
| 43 | +export SUPER_ADMIN_USERNAME="admin" |
| 44 | +export SUPER_ADMIN_PASSWORD="297df52fbc321ebf7198d497fe1c9206PlsChangeMe" |
| 45 | +``` |
27 | 46 |
|
28 | | -2. Starten Sie MCP Gateway mit Docker: |
| 47 | +Ein-Klick-Bereitstellung: |
29 | 48 |
|
30 | 49 | ```bash |
31 | 50 | docker run -d \ |
32 | | - --name mcp-gateway \ |
33 | | - -p 8080:80 \ |
34 | | - -p 5234:5234 \ |
35 | | - -p 5235:5235 \ |
36 | | - -p 5335:5335 \ |
37 | | - -p 5236:5236 \ |
38 | | - -e ENV=production \ |
39 | | - -v $(pwd)/configs:/app/configs \ |
40 | | - -v $(pwd)/data:/app/data \ |
41 | | - -v $(pwd)/.env.allinone:/app/.env \ |
42 | | - --restart unless-stopped \ |
43 | | - ghcr.io/mcp-ecosystem/mcp-gateway/allinone:latest |
| 51 | + --name mcp-gateway \ |
| 52 | + -p 8080:80 \ |
| 53 | + -p 5234:5234 \ |
| 54 | + -p 5235:5235 \ |
| 55 | + -p 5335:5335 \ |
| 56 | + -p 5236:5236 \ |
| 57 | + -e ENV=production \ |
| 58 | + -e TZ=Asia/Shanghai \ |
| 59 | + -e OPENAI_BASE_URL=${OPENAI_BASE_URL} \ |
| 60 | + -e OPENAI_API_KEY=${OPENAI_API_KEY} \ |
| 61 | + -e OPENAI_MODEL=${OPENAI_MODEL} \ |
| 62 | + -e APISERVER_JWT_SECRET_KEY=${APISERVER_JWT_SECRET_KEY} \ |
| 63 | + -e SUPER_ADMIN_USERNAME=${SUPER_ADMIN_USERNAME} \ |
| 64 | + -e SUPER_ADMIN_PASSWORD=${SUPER_ADMIN_PASSWORD} \ |
| 65 | + --restart unless-stopped \ |
| 66 | + registry.ap-southeast-1.aliyuncs.com/mcp-ecosystem/mcp-gateway-allinone:latest |
44 | 67 | ``` |
45 | 68 |
|
46 | 69 | ## Zugriff und Konfiguration |
47 | 70 |
|
48 | | -1. Greifen Sie auf die Web-UI zu: |
49 | | - - Öffnen Sie einen Browser und navigieren Sie zu http://localhost:8080/ |
| 71 | +1. Web-UI aufrufen: |
| 72 | + - Öffnen Sie http://localhost:8080/ in Ihrem Browser |
| 73 | + - Melden Sie sich mit den konfigurierten Administrator-Anmeldedaten an |
50 | 74 |
|
51 | | -2. Fügen Sie einen neuen MCP-Server hinzu: |
52 | | - - Kopieren Sie die Konfigurationsdatei: https://github.com/mcp-ecosystem/mcp-gateway/blob/main/configs/mock-user-svc.yaml |
53 | | - - Klicken Sie in der Web-UI auf "Add MCP Server" |
54 | | - - Fügen Sie die Konfiguration ein und speichern Sie sie |
| 75 | +2. Neuen MCP-Server hinzufügen: |
| 76 | + - Konfigurationsdatei kopieren: https://github.com/mcp-ecosystem/mcp-gateway/blob/main/configs/mock-user-svc.yaml |
| 77 | + - In der Web-UI auf "Add MCP Server" klicken |
| 78 | + - Konfiguration einfügen und speichern |
55 | 79 |
|
56 | | -  |
| 80 | +  |
57 | 81 |
|
58 | 82 | ## Verfügbare Endpunkte |
59 | 83 |
|
60 | | -Nach der Konfiguration können Sie den Service über folgende Endpunkte nutzen: |
| 84 | +Nach der Konfiguration sind die Dienste an folgenden Endpunkten verfügbar: |
61 | 85 |
|
62 | 86 | - MCP SSE: http://localhost:5235/mcp/user/sse |
63 | | -- MCP HTTP Streamable: http://localhost:5235/mcp/user/message |
| 87 | +- MCP Streamable HTTP: http://localhost:5235/mcp/user/message |
64 | 88 | - MCP: http://localhost:5235/mcp/user/mcp |
65 | 89 |
|
66 | 90 | ## Testen |
67 | 91 |
|
68 | | -Der Service kann auf zwei Arten getestet werden: |
| 92 | +Sie können den Dienst auf zwei Arten testen: |
| 93 | + |
| 94 | +1. Verwenden Sie die MCP Chat-Seite in der Web-UI |
| 95 | +2. Verwenden Sie Ihren eigenen MCP-Client (**empfohlen**) |
| 96 | + |
| 97 | +## Erweiterte Konfiguration (Optional) |
69 | 98 |
|
70 | | -1. Verwenden Sie die MCP Chat-Seite in der Web-UI (API-Schlüssel in `.env.allinone` erforderlich) |
71 | | -2. Verwenden Sie Ihren eigenen MCP-Client (**empfohlen**) |
| 99 | +Wenn Sie eine feinere Kontrolle über die Konfiguration benötigen, können Sie den Dienst durch Einbinden von Konfigurationsdateien starten: |
| 100 | + |
| 101 | +1. Erstellen Sie die erforderlichen Verzeichnisse und laden Sie die Konfigurationsdateien herunter: |
| 102 | + |
| 103 | +```bash |
| 104 | +mkdir -p mcp-gateway/{configs,data} |
| 105 | +cd mcp-gateway/ |
| 106 | +curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/configs/apiserver.yaml -o configs/apiserver.yaml |
| 107 | +curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/configs/mcp-gateway.yaml -o configs/mcp-gateway.yaml |
| 108 | +curl -sL https://raw.githubusercontent.com/mcp-ecosystem/mcp-gateway/refs/heads/main/.env.example -o .env.allinone |
| 109 | +``` |
| 110 | + |
| 111 | +2. MCP Gateway mit Docker ausführen: |
| 112 | + |
| 113 | +```bash |
| 114 | +docker run -d \ |
| 115 | + --name mcp-gateway \ |
| 116 | + -p 8080:80 \ |
| 117 | + -p 5234:5234 \ |
| 118 | + -p 5235:5235 \ |
| 119 | + -p 5335:5335 \ |
| 120 | + -p 5236:5236 \ |
| 121 | + -e ENV=production \ |
| 122 | + -v $(pwd)/configs:/app/configs \ |
| 123 | + -v $(pwd)/data:/app/data \ |
| 124 | + -v $(pwd)/.env.allinone:/app/.env \ |
| 125 | + --restart unless-stopped \ |
| 126 | + ghcr.io/mcp-ecosystem/mcp-gateway/allinone:latest |
| 127 | +``` |
0 commit comments