mirror of
https://github.com/claude-did-this/claude-hub.git
synced 2026-02-14 19:30:02 +01:00
docs: consolidate documentation structure
Unified documentation approach with single source of truth: **Consolidated into main README.md:** - All three authentication methods (Setup Container, API Key, AWS Bedrock) - Quick setup instructions with links to detailed guides - Clear indication of which method to use for different scenarios **Removed docs/README.md:** - Eliminated duplication between root and docs README - Keep docs/ only for deeper technical guides when needed **Updated structure:** - Main README: Complete setup and quick start information - docs/: Technical deep-dive guides only (setup-container-guide.md, etc.) - Clear documentation hierarchy in main README This provides a better user experience with the main README as the authoritative getting-started guide, and docs/ for detailed technical implementation when users need deeper information. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Jonathan
57
README.md
57
README.md
@@ -124,7 +124,16 @@ BOT_USERNAME=YourBotName # GitHub bot account username (create your
|
||||
GITHUB_WEBHOOK_SECRET=<generated> # Webhook validation
|
||||
GITHUB_TOKEN=<fine-grained-pat> # Repository access (from your bot account)
|
||||
|
||||
# AWS Bedrock (recommended)
|
||||
# Claude Authentication - Choose ONE method:
|
||||
|
||||
# Option 1: Setup Container (Personal/Development)
|
||||
# Use existing Claude Max subscription (5x or 20x plans)
|
||||
# See docs/setup-container-guide.md for setup
|
||||
|
||||
# Option 2: Direct API Key (Production/Team)
|
||||
ANTHROPIC_API_KEY=sk-ant-your-api-key
|
||||
|
||||
# Option 3: AWS Bedrock (Enterprise)
|
||||
AWS_REGION=us-east-1
|
||||
ANTHROPIC_MODEL=anthropic.claude-3-sonnet-20240229-v1:0
|
||||
CLAUDE_CODE_USE_BEDROCK=1
|
||||
@@ -134,6 +143,44 @@ AUTHORIZED_USERS=user1,user2,user3 # Allowed GitHub usernames
|
||||
CLAUDE_API_AUTH_REQUIRED=1 # Enable API authentication
|
||||
```
|
||||
|
||||
## Authentication Methods
|
||||
|
||||
### Setup Container (Personal/Development)
|
||||
Use your existing Claude Max subscription for automation instead of pay-per-use API fees:
|
||||
|
||||
```bash
|
||||
# 1. Run interactive authentication setup
|
||||
./scripts/setup/setup-claude-interactive.sh
|
||||
|
||||
# 2. In container: authenticate with your subscription
|
||||
claude login # Follow browser flow
|
||||
exit # Save authentication
|
||||
|
||||
# 3. Use captured authentication
|
||||
cp -r ${CLAUDE_HUB_DIR:-~/.claude-hub}/* ~/.claude/
|
||||
```
|
||||
|
||||
**Prerequisites**: Claude Max subscription (5x or 20x plans). Claude Pro does not include Claude Code access.
|
||||
**Details**: [Setup Container Guide](./docs/setup-container-guide.md)
|
||||
|
||||
### Direct API Key (Production/Team)
|
||||
```bash
|
||||
ANTHROPIC_API_KEY=sk-ant-your-api-key-here
|
||||
```
|
||||
|
||||
**Best for**: Production environments, team usage, guaranteed stability.
|
||||
**Details**: [Authentication Guide](./docs/claude-authentication-guide.md)
|
||||
|
||||
### AWS Bedrock (Enterprise)
|
||||
```bash
|
||||
AWS_REGION=us-east-1
|
||||
ANTHROPIC_MODEL=anthropic.claude-3-sonnet-20240229-v1:0
|
||||
CLAUDE_CODE_USE_BEDROCK=1
|
||||
```
|
||||
|
||||
**Best for**: Enterprise deployments, AWS integration, compliance requirements.
|
||||
**Details**: [Authentication Guide](./docs/claude-authentication-guide.md)
|
||||
|
||||
### 2. GitHub Webhook Setup
|
||||
|
||||
1. Navigate to Repository → Settings → Webhooks
|
||||
@@ -283,11 +330,17 @@ DEBUG=claude:* npm run dev
|
||||
|
||||
## Documentation
|
||||
|
||||
### Deep Dive Guides
|
||||
- [Setup Container Authentication](./docs/setup-container-guide.md) - Technical details for subscription-based auth
|
||||
- [Authentication Guide](./docs/claude-authentication-guide.md) - All authentication methods and troubleshooting
|
||||
- [Complete Workflow](./docs/complete-workflow.md) - End-to-end technical guide
|
||||
- [Container Setup](./docs/container-setup.md) - Docker configuration details
|
||||
- [AWS Best Practices](./docs/aws-authentication-best-practices.md) - IAM and credential management
|
||||
- [GitHub Integration](./docs/github-workflow.md) - Webhook events and permissions
|
||||
- [Scripts Reference](./SCRIPTS.md) - Utility scripts documentation
|
||||
|
||||
### Reference
|
||||
- [Scripts Documentation](./docs/SCRIPTS.md) - Utility scripts and commands
|
||||
- [Command Reference](./CLAUDE.md) - Build and run commands
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
153
docs/README.md
153
docs/README.md
@@ -1,153 +0,0 @@
|
||||
# Claude Hub Documentation
|
||||
|
||||
Welcome to the Claude GitHub Webhook service documentation! This service enables Claude AI to respond to GitHub events and automate repository workflows.
|
||||
|
||||
## 📋 Quick Start Guides
|
||||
|
||||
### For Developers with Claude Subscriptions
|
||||
**💡 Recommended for personal projects and development**
|
||||
|
||||
You can use your existing Claude Max subscription (5x or 20x plans) instead of paying API fees:
|
||||
|
||||
1. **[Setup Container Authentication](./setup-container-guide.md)** - Use your subscription for automation
|
||||
2. **[Complete Authentication Guide](./claude-authentication-guide.md)** - All authentication methods
|
||||
|
||||
### For Production and Teams
|
||||
**🏢 Recommended for production applications**
|
||||
|
||||
- **[ANTHROPIC_API_KEY Setup](./claude-authentication-guide.md#-option-2-anthropic_api_key-productionteam)** - Direct API key authentication
|
||||
- **[AWS Bedrock Setup](./claude-authentication-guide.md#️-option-3-aws-bedrock-enterprise)** - Enterprise-grade deployment
|
||||
|
||||
## 🚀 Key Features
|
||||
|
||||
### GitHub Integration
|
||||
- **Auto-tagging**: Automatically categorize and label new issues
|
||||
- **PR Reviews**: Comprehensive automated pull request reviews
|
||||
- **Webhook Responses**: Claude responds to mentions in issues and PRs
|
||||
- **CLI Access**: Direct command-line interface for testing
|
||||
|
||||
### Authentication Flexibility
|
||||
- **Personal**: Use Claude Max subscriptions (5x or 20x plans) via setup container
|
||||
- **Production**: ANTHROPIC_API_KEY for stable production usage
|
||||
- **Enterprise**: AWS Bedrock integration for compliance and scale
|
||||
|
||||
### Security & Reliability
|
||||
- **Container Isolation**: Secure execution environment
|
||||
- **Credential Management**: Multiple secure authentication methods
|
||||
- **Rate Limiting**: Built-in protection against abuse
|
||||
- **Logging**: Comprehensive audit trail
|
||||
|
||||
## 📚 Documentation Index
|
||||
|
||||
### Getting Started
|
||||
- **[Main README](../README.md)** - Project overview and basic setup
|
||||
- **[CLAUDE.md](../CLAUDE.md)** - Complete build and run commands
|
||||
- **[Authentication Guide](./claude-authentication-guide.md)** - Choose your auth method
|
||||
|
||||
### Authentication Methods
|
||||
- **[Setup Container Guide](./setup-container-guide.md)** - Use your Claude subscription
|
||||
- **[AWS Authentication](./aws-authentication-best-practices.md)** - Enterprise AWS setup
|
||||
- **[Credential Security](./credential-security.md)** - Security best practices
|
||||
|
||||
### Workflows & CI/CD
|
||||
- **[Complete Workflow](./complete-workflow.md)** - End-to-end process documentation
|
||||
- **[GitHub Workflow](./github-workflow.md)** - GitHub-specific integration
|
||||
- **[Docker CI/CD](./docker-ci-cd.md)** - Container deployment
|
||||
- **[PR Review Workflow](./pr-review-workflow.md)** - Automated code reviews
|
||||
|
||||
### Container & Deployment
|
||||
- **[Container Setup](./container-setup.md)** - Docker configuration
|
||||
- **[Container Limitations](./container-limitations.md)** - Known constraints
|
||||
- **[Docker Optimization](./docker-optimization.md)** - Performance tuning
|
||||
|
||||
### Security & Operations
|
||||
- **[Logging Security](./logging-security.md)** - Secure logging practices
|
||||
- **[Pre-commit Setup](./pre-commit-setup.md)** - Code quality automation
|
||||
- **[Scripts Documentation](./SCRIPTS.md)** - Available utility scripts
|
||||
|
||||
## 🎯 Authentication Method Selection
|
||||
|
||||
### Individual Developers
|
||||
- **Setup Container**: Use existing Claude Max subscription for automation
|
||||
- **API Key**: Direct API access for stable production usage
|
||||
|
||||
### Small Teams
|
||||
- **ANTHROPIC_API_KEY**: Recommended for team environments
|
||||
- **Setup Container**: Alternative for development workflows
|
||||
|
||||
### Enterprise
|
||||
- **AWS Bedrock**: Enterprise-grade deployment with compliance features
|
||||
- **ANTHROPIC_API_KEY**: Alternative with enterprise support
|
||||
|
||||
## 🔧 Quick Commands
|
||||
|
||||
### Authentication Setup
|
||||
```bash
|
||||
# Personal/Development (use Claude subscription)
|
||||
./scripts/setup/setup-claude-interactive.sh
|
||||
|
||||
# Production (API key)
|
||||
echo "ANTHROPIC_API_KEY=sk-ant-your-key" >> .env
|
||||
|
||||
# Enterprise (AWS Bedrock)
|
||||
./scripts/aws/create-aws-profile.sh
|
||||
```
|
||||
|
||||
### Service Management
|
||||
```bash
|
||||
# Start services
|
||||
docker compose up -d
|
||||
|
||||
# View logs
|
||||
docker compose logs -f webhook
|
||||
|
||||
# Restart services
|
||||
docker compose restart webhook
|
||||
|
||||
# Test webhook
|
||||
node cli/webhook-cli.js --repo "owner/repo" --command "Hello Claude!" --url "http://localhost:8082"
|
||||
```
|
||||
|
||||
### Development
|
||||
```bash
|
||||
# Run tests
|
||||
npm test
|
||||
|
||||
# Type checking
|
||||
npm run typecheck
|
||||
|
||||
# Linting
|
||||
npm run lint
|
||||
|
||||
# Build
|
||||
npm run build
|
||||
```
|
||||
|
||||
## 🆘 Support & Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
1. **Authentication Problems**: See [Authentication Guide](./claude-authentication-guide.md)
|
||||
2. **Container Issues**: Check [Container Limitations](./container-limitations.md)
|
||||
3. **GitHub Integration**: Review [GitHub Workflow](./github-workflow.md)
|
||||
4. **Performance**: Consult [Docker Optimization](./docker-optimization.md)
|
||||
|
||||
### Getting Help
|
||||
- **Documentation**: Check the relevant guide above
|
||||
- **Logs**: Use `docker compose logs -f webhook` for debugging
|
||||
- **Testing**: Use CLI tools for isolated testing
|
||||
- **Community**: Share experiences and solutions
|
||||
|
||||
## Technical Features
|
||||
|
||||
### Setup Container Method
|
||||
The setup container approach captures Claude CLI authentication state for use in automated environments, enabling subscription-based authentication.
|
||||
|
||||
### Multi-tier Authentication
|
||||
Supports multiple authentication methods from personal development to enterprise deployment with security and compliance features.
|
||||
|
||||
### Production Ready
|
||||
Includes comprehensive logging, security, container isolation, and monitoring capabilities for production usage.
|
||||
|
||||
---
|
||||
|
||||
**Getting Started**: Choose your authentication method and follow the corresponding guide above.
|
||||
@@ -14,7 +14,7 @@ This guide covers three authentication methods for using Claude with the webhook
|
||||
|
||||
## 🐳 Option 1: Setup Container (Development/Personal)
|
||||
|
||||
**Best for:** Developers with Claude Max subscriptions (5x or 20x plans) who want to use their existing subscription for automation. Note: Claude Code is not included with Claude Pro plans.
|
||||
**Best for:** Developers with Claude Max subscriptions (10x or 20x plans) who want to use their existing subscription for automation. Note: Claude Code is not included with Claude Pro plans.
|
||||
|
||||
### Advantages
|
||||
- ✅ **Cost-effective**: Use your existing Claude subscription
|
||||
|
||||
Reference in New Issue
Block a user