Webservice
The Webservice is a core component of the ctrlplane application, it providers
both the frontend and API gateway for the application.
Deployment
- Docker Image:
docker.io/ctrlplane/webservice:latest, Dockerfile (opens in a new tab) - Helm Chart (opens in a new tab)
Technology:
- NextJS (opens in a new tab)
- TypeScript (opens in a new tab)
- React (opens in a new tab)
- TailwindCSS (opens in a new tab)
- tRPC (opens in a new tab)
Environment Variables
| Variable | Default | Description | Optional |
|---|---|---|---|
POSTGRES_URL | postgresql://ctrlplane:ctrlplane@127.0.0.1:5432/ctrlplane | URL for connecting to the PostgreSQL database. | No |
REDIS_URL | redis://127.0.0.1:6379 | URL for connecting to the Redis database. | No |
BASE_URL | URL for GitHub instance. | No | |
GITHUB_URL | https://github.com (opens in a new tab) | URL for GitHub integration. | Yes |
GITHUB_BOT_NAME | Name of the GitHub bot. | Yes | |
GITHUB_BOT_PRIVATE_KEY | Private key for the GitHub bot. | Yes | |
GITHUB_BOT_CLIENT_ID | Client ID for the GitHub bot. | Yes | |
GITHUB_BOT_CLIENT_SECRET | Client secret for the GitHub bot. | Yes | |
GITHUB_BOT_APP_ID | App ID for the GitHub bot. | Yes | |
WORKSPACE_CREATE_GOOGLE_SERVICE_ACCOUNTS | false | Whether to create Google service accounts for workspaces. | Yes |