Skip to content

Commit b3337db

Browse files
authored
Merge pull request #52 from agentic-community/fix-docs-nginx-updates
Fix documentation and nginx config updates
2 parents e8816a0 + 90861c0 commit b3337db

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,9 @@ For production deployments with SSL certificates:
362362
sudo mkdir -p /home/ubuntu/ssl_data/certs
363363
sudo mkdir -p /home/ubuntu/ssl_data/private
364364
# Copy your certificate and private key files to these directories
365+
# Important: Name your files as follows:
366+
# - Certificate file: fullchain.pem (goes in /home/ubuntu/ssl_data/certs/)
367+
# - Private key file: privkey.pem (goes in /home/ubuntu/ssl_data/private/)
365368
```
366369

367370
4. **Deploy with HTTPS:** Run the deployment script as normal:
@@ -400,6 +403,7 @@ For production deployments with SSL certificates:
400403

401404
3. **Run the agent with session cookie:**
402405
```bash
406+
# your_registry_url would typically be http://localhost/mcpgw/sse or https://mymcpgateway.mycorp.com/mcpgw/sse
403407
python agents/agent.py --use-session-cookie --mcp-registry-url your_registry_url --message "what is the current time in clarksburg, md"
404408
```
405409

@@ -418,6 +422,7 @@ For production deployments with SSL certificates:
418422
The agent will communicate with Cognito to obtain a JWT token which will include information about the groups it is part of. This information is then used by the Auth server for authorization decisions.
419423

420424
```bash
425+
# your_registry_url would typically be http://localhost/mcpgw/sse or https://mymcpgateway.mycorp.com/mcpgw/sse
421426
python agents/agent.py --mcp-registry-url your_registry_url --message "what is the current time in clarksburg, md"
422427
```
423428

docker/nginx_rev_proxy.conf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Nginx configuration directive for handling long server names
2+
server_names_hash_bucket_size 128;
3+
14
# First server block now directly handles HTTP requests instead of redirecting
25
server {
36
listen 80;

docs/FAQ.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,9 @@ The script handles Docker image building, service orchestration, and health chec
258258
sudo mkdir -p /home/ubuntu/ssl_data/certs
259259
sudo mkdir -p /home/ubuntu/ssl_data/private
260260
# Copy your certificate files to these directories
261+
# Important: Name your files as follows:
262+
# - Certificate file: fullchain.pem (goes in /home/ubuntu/ssl_data/certs/)
263+
# - Private key file: privkey.pem (goes in /home/ubuntu/ssl_data/private/)
261264
```
262265

263266
2. **Update security group** to allow port 443

docs/cognito.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ Create `.env.user` file in the `agents/` directory:
201201
# Cognito Configuration
202202
COGNITO_USER_POOL_ID=us-east-1_XXXXXXXXX
203203
COGNITO_CLIENT_ID=your-public-client-id
204+
COGNITO_CLIENT_SECRET=your-client-secret
204205
SECRET_KEY=your-secret-key-matching-registry
205206

206207
# Optional: Custom domain

0 commit comments

Comments
 (0)