ByteProxy Docs

This directory contains additional documentation for the ByteProxy project.

• Getting Started
• Configuration Options
• API Reference
• Service Management
• Troubleshooting

ByteProxy is a powerful API proxy server that forwards requests to various services like Discord, GitHub, and others.

• Bun runtime (v1.0.0 or later)
• Discord Bot Token (optional)
• GitHub API Token (optional)

1. Clone the repository:

   git clone https://github.com/ByteBrushStudios/ByteProxy.git
   cd ByteProxy

2. Install dependencies:

   bun install

3. Set up environment variables:

   cp .env.example .env.local

4. Edit .env.local with your API tokens and configuration settings.

5. Start the development server:

   bun run dev

ByteProxy is highly configurable through environment variables and the service registry in src/config/index.ts.

ByteProxy provides a comprehensive API divided into several categories:

• GET / - Welcome page with links to documentation
• GET /up - Server health and pressure status

• GET /health - Basic health check
• GET /status - Detailed server status

• ALL /proxy/:service/* - Forward requests to configured services
  • Example: GET /proxy/github/users/octocat

• GET /manage/services - List all configured services
• GET /manage/services/:key - Get service configuration
• POST /manage/services - Add a new service
• POST /manage/services/:key/test - Test service connectivity
• GET /manage/diagnostics - System diagnostics
• GET /manage/key-debug - API key information

• GET /version/check - Check for ByteProxy updates

You can dynamically add, configure, and test services through the management API.

curl -X POST http://localhost:3420/manage/services \
  -H "Content-Type: application/json" \
  -d '{
    "key": "twitter",
    "config": {
      "name": "Twitter API",
      "baseUrl": "https://api.twitter.com/2/",
      "headers": {
        "User-Agent": "ByteProxy/0.1.0"
      },
      "auth": {
        "type": "bearer",
        "tokenEnvVar": "TWITTER_TOKEN"
      }
    }
  }'

curl -X POST http://localhost:3420/manage/services/github/test

If you encounter issues, check the following resources:

1. System diagnostics at /manage/diagnostics
2. Authentication settings at /manage/key-debug
3. Console logs for detailed error messages
4. Environment variable configuration

Common issues:

• Authentication failures: Check API tokens in .env.local
• TLS/SSL errors: Consider setting STRICT_TLS=false for development
• 404 errors: Verify service keys and endpoint paths
• Rate limiting: Check service configuration for rate limit settings

For additional help, join our Discord community or create an issue on GitHub.