Skip to content

Commit e60b6a8

Browse files
committed
docs: add Quick Start for shared server setup
1 parent 15d7670 commit e60b6a8

1 file changed

Lines changed: 28 additions & 10 deletions

File tree

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -238,18 +238,18 @@ You: configure_allure_token(token="your-api-token-here")
238238

239239
## Shared Server Setup
240240

241-
If your team wants to run a **single shared server** instead of per-user setup:
241+
### Quick Start for Shared Server (Team Lead)
242242

243-
### 1️⃣ Get a Shared API Token
243+
If your team wants to run a **single shared server** instead of per-user setup:
244244

245+
#### 1️⃣ Get a Shared API Token
245246
1. In Allure TestOps, create a dedicated **service account** or use a shared admin token
246247
2. Copy the API token
247248
3. Keep it in a secure location (it will be in the server's `.env`)
248249

249-
### 2️⃣ Deploy the Server
250-
250+
#### 2️⃣ Download & Start Server
251251
```bash
252-
# Download binary for your platform
252+
# Download binary (same as above, but for your server's OS)
253253
# https://github.com/MimoJanra/TestOpsMCP/releases/latest
254254

255255
# Create .env file
@@ -258,17 +258,35 @@ ALLURE_BASE_URL=https://your-testops-instance.com
258258
ALLURE_TOKEN=your-shared-api-token
259259
PORT=3000
260260
LOG_LEVEL=INFO
261-
MCP_AUTH_TOKEN=secure-random-string-here
262-
CORS_ALLOWED_ORIGIN=https://claude.ai
263261
EOF
264262

265-
# Run in HTTP mode
263+
# Run the server
266264
./testops-mcp-linux-amd64 --http
267265
```
268266

269-
Server starts on `http://localhost:3000`
267+
Server starts on `http://localhost:3000`
268+
269+
#### 3️⃣ Share with Team
270+
Tell your team to add this to their **Claude Desktop config**:
271+
272+
```json
273+
"mcpServers": {
274+
"testops": {
275+
"command": "http://your-server-address:3000"
276+
}
277+
}
278+
```
279+
280+
**Replace** `your-server-address` with:
281+
- Local network? → `http://192.168.1.100:3000` (your server's IP)
282+
- Internet? → `https://mcp.yourcompany.com` (your domain with HTTPS)
283+
284+
#### 4️⃣ Team restarts Claude Desktop
285+
They'll see the TestOps tools immediately! 🎉
286+
287+
---
270288

271-
**Full team deployment guide:** [Shared Server & DevOps Setup](#shared-server--devops-guide-below)
289+
**Full DevOps guide:** [See DEPLOYMENT.md](./docs/DEPLOYMENT.md) for Docker, Kubernetes, Nginx, systemd, ngrok, and more.
272290

273291
---
274292

0 commit comments

Comments
 (0)