132 lines
2.3 KiB
Markdown
132 lines
2.3 KiB
Markdown
# Quick Start Guide
|
|
|
|
Get AegisGitea MCP running in 5 minutes.
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- Docker and Docker Compose installed
|
|
- Self-hosted Gitea instance
|
|
- 5 minutes of your time
|
|
|
|
---
|
|
|
|
## Step 1: Create Bot User (2 minutes)
|
|
|
|
1. Log into your Gitea instance
|
|
2. Create a new user `aegis-bot` (or any name you prefer)
|
|
3. Go to Settings > Applications
|
|
4. Generate an access token with **read-only** permissions
|
|
5. Copy the token
|
|
|
|
---
|
|
|
|
## Step 2: Clone and Configure (1 minute)
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone <your-repo-url>
|
|
cd AegisGitea-MCP
|
|
|
|
# Configure environment
|
|
cp .env.example .env
|
|
nano .env
|
|
```
|
|
|
|
Edit `.env`:
|
|
```bash
|
|
GITEA_URL=https://your-gitea-instance.com
|
|
GITEA_TOKEN=your-bot-token-here
|
|
```
|
|
|
|
---
|
|
|
|
## Step 3: Start Server (1 minute)
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
Verify it's running:
|
|
```bash
|
|
# Check logs
|
|
docker-compose logs -f
|
|
|
|
# Test health endpoint
|
|
curl http://localhost:8080/health
|
|
```
|
|
|
|
Expected response:
|
|
```json
|
|
{"status": "healthy"}
|
|
```
|
|
|
|
---
|
|
|
|
## Step 4: Grant Repository Access (1 minute)
|
|
|
|
1. Go to a repository in Gitea
|
|
2. Settings > Collaborators
|
|
3. Add `aegis-bot` user
|
|
4. Set permission to **Read**
|
|
|
|
---
|
|
|
|
## Step 5: Connect ChatGPT (Optional)
|
|
|
|
If using ChatGPT Business/Developer:
|
|
|
|
1. Go to ChatGPT Settings
|
|
2. Add MCP Server:
|
|
- **URL**: `http://localhost:8080` (or your domain)
|
|
- **Type**: HTTP/SSE
|
|
3. Test by asking: "List my Gitea repositories"
|
|
|
|
---
|
|
|
|
## What's Next?
|
|
|
|
- Read [DEPLOYMENT.md](DEPLOYMENT.md) for production setup
|
|
- Review [SECURITY.md](SECURITY.md) for security best practices
|
|
- Check audit logs: `docker-compose exec aegis-mcp cat /var/log/aegis-mcp/audit.log`
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### Container won't start
|
|
|
|
```bash
|
|
docker-compose logs aegis-mcp
|
|
```
|
|
|
|
Common issues:
|
|
- Invalid `GITEA_URL` or `GITEA_TOKEN` in `.env`
|
|
- Port 8080 already in use
|
|
- Gitea instance not accessible
|
|
|
|
### Bot can't see repositories
|
|
|
|
1. Verify bot user is added as collaborator
|
|
2. Check bot user has Read permission
|
|
3. Confirm repository is not archived
|
|
|
|
### ChatGPT can't connect
|
|
|
|
- Ensure MCP server is accessible from ChatGPT
|
|
- Check firewall rules
|
|
- Verify HTTPS is configured (required for production)
|
|
|
|
---
|
|
|
|
## Need Help?
|
|
|
|
- Check the [README.md](README.md) for detailed documentation
|
|
- Review logs for error messages
|
|
- Open an issue in the repository
|
|
|
|
---
|
|
|
|
**You're all set!** The AI can now securely access your Gitea repositories.
|