2.3 KiB
2.3 KiB
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)
- Log into your Gitea instance
- Create a new user
aegis-bot(or any name you prefer) - Go to Settings > Applications
- Generate an access token with read-only permissions
- Copy the token
Step 2: Clone and Configure (1 minute)
# Clone repository
git clone <your-repo-url>
cd AegisGitea-MCP
# Configure environment
cp .env.example .env
nano .env
Edit .env:
GITEA_URL=https://your-gitea-instance.com
GITEA_TOKEN=your-bot-token-here
Step 3: Start Server (1 minute)
docker-compose up -d
Verify it's running:
# Check logs
docker-compose logs -f
# Test health endpoint
curl http://localhost:8080/health
Expected response:
{"status": "healthy"}
Step 4: Grant Repository Access (1 minute)
- Go to a repository in Gitea
- Settings > Collaborators
- Add
aegis-botuser - Set permission to Read
Step 5: Connect ChatGPT (Optional)
If using ChatGPT Business/Developer:
- Go to ChatGPT Settings
- Add MCP Server:
- URL:
http://localhost:8080(or your domain) - Type: HTTP/SSE
- URL:
- Test by asking: "List my Gitea repositories"
What's Next?
- Read DEPLOYMENT.md for production setup
- Review 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
docker-compose logs aegis-mcp
Common issues:
- Invalid
GITEA_URLorGITEA_TOKENin.env - Port 8080 already in use
- Gitea instance not accessible
Bot can't see repositories
- Verify bot user is added as collaborator
- Check bot user has Read permission
- 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 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.