{"id":31419406,"url":"https://github.com/compiler-explorer/ce-router","last_synced_at":"2025-09-29T22:57:34.280Z","repository":{"id":313814873,"uuid":"1052453023","full_name":"compiler-explorer/ce-router","owner":"compiler-explorer","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-15T23:23:05.000Z","size":207,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-15T23:28:15.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compiler-explorer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-08T04:37:16.000Z","updated_at":"2025-09-15T23:21:46.000Z","dependencies_parsed_at":"2025-09-08T17:45:27.462Z","dependency_job_id":null,"html_url":"https://github.com/compiler-explorer/ce-router","commit_stats":null,"previous_names":["compiler-explorer/ce-router"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/compiler-explorer/ce-router","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compiler-explorer%2Fce-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compiler-explorer%2Fce-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compiler-explorer%2Fce-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compiler-explorer%2Fce-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compiler-explorer","download_url":"https://codeload.github.com/compiler-explorer/ce-router/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compiler-explorer%2Fce-router/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277601098,"owners_count":25845629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-29T02:00:09.175Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-29T22:57:32.743Z","updated_at":"2025-09-29T22:57:34.267Z","avatar_url":"https://github.com/compiler-explorer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CE Router\n\nA TypeScript-based router service for Compiler Explorer that handles compilation requests and routes them to appropriate backend services.\n\n## Features\n\n- **Environment-based routing**: Support for production, beta, and staging environments\n- **Multiple routing modes**: Queue-based (SQS) and URL-based forwarding\n- **WebSocket integration**: Real-time compilation results via WebSocket connections\n- **S3 overflow support**: Automatic handling of large compilation outputs via S3 storage\n- **Comprehensive logging**: Winston-based structured logging with remote logging support\n- **CORS support**: Cross-origin request handling for web frontends\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Run in development mode with hot reload\nnpm run dev\n\n# Build for production\nnpm run build\n\n# Run tests\nnpm run test\n\n# Lint and format code\nnpm run lint\n\n# Type check\nnpm run typecheck\n```\n\n## Usage\n\n### From Release Archive\n\nDownload the latest release archive from [GitHub Releases](../../releases) and extract it:\n\n```bash\n# Extract the release archive\nunzip ce-router-v1.0.0.zip\ncd ce-router-v1.0.0\n\n# Start the server (environment is required)\nnode index.js --env prod\n\n# With custom port\nnode index.js --env prod --port 8080\n\n# With remote logging\nnode index.js --env prod --logHost logs.example.com --logPort 514\n\n# With custom WebSocket URL\nnode index.js --env prod --websocket wss://custom.websocket.url\n```\n\n### From Source\n\n```bash\n# Start the server (environment is required)\nnode dist/index.js --env prod\n\n# With custom port\nnode dist/index.js --env prod --port 8080\n\n# With remote logging\nnode dist/index.js --env prod --logHost logs.example.com --logPort 514\n\n# With custom WebSocket URL\nnode dist/index.js --env prod --websocket wss://custom.websocket.url\n```\n\n## CLI Parameters\n\n| Parameter | Short | Description | Default | Required |\n|-----------|-------|-------------|---------|----------|\n| `--env` | | Environment: `prod`, `beta`, or `staging` | | ✅ |\n| `--port` | `-p` | Port to run the server on | `10240` | |\n| `--websocket` | `-w` | WebSocket server URL | Environment-specific | |\n| `--logHost` | | Hostname for remote logging | | |\n| `--logPort` | | Port for remote logging | | |\n| `--sqs-max-size` | | Maximum SQS message size in bytes | `262144` | |\n| `--s3-overflow-bucket` | | S3 bucket for overflow messages | `temp-storage.godbolt.org` | |\n| `--s3-overflow-prefix` | | S3 key prefix for overflow messages | `sqs-overflow/` | |\n| `--help` | `-h` | Show help information | | |\n| `--version` | `-V` | Show version number | | |\n\n## Environment Variables\n\n- AWS credentials for SQS, DynamoDB, and SSM access\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompiler-explorer%2Fce-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompiler-explorer%2Fce-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompiler-explorer%2Fce-router/lists"}