System Initialization
Running the Installation Wizard, configuring telemetry, and registering the cluster topology.
Once the Frontend service is running, the platform enters "Install Mode." You must complete this wizard to seed the database and create your root administrator account.
1. The Installation Wizard
Navigate to your frontend URL (e.g., http://localhost or https://app.your-domain.com). You will be redirected to /install.
Admin Account
Create the Root Administrator.
- Email: This will be used for system alerts.
- Password: Set a strong password.
Telemetry Settings
We believe in transparency.
- Core Telemetry (Mandatory): We collect your App Version and Admin Contact email. This allows us to notify you of critical security patches.
- Usage Telemetry (Optional): You can opt-in to share aggregated stats (e.g., "Total Calls Processed", "Hardware Specs").
- Privacy: No PII (Personally Identifiable Information) or conversation content is ever sent.
Automatic Seeding
Upon clicking Install, the system will populate the database with:
- Default Integration Types (OpenAI, Twilio, etc.).
- Default Services (LLM, TTS, STT definitions).
- Default Languages list.
2. Registering Infrastructure
Now that you are logged in, go to the Admin Dashboard (/admin). You need to tell the database where your worker nodes are running.
Deep Dive
For a detailed explanation of the topology fields, see the Admin Infrastructure Guide.
Create Region
- Navigate to Infrastructure -> Regions.
- Click Add Region.
- Name:
Default Region(orUS-East). - Identifier:
us-east-1(Used for routing logic).
Register Proxy & Backend
Inside the Region view:
- Add Proxy:
- Endpoint: The URL (e.g.,
https://proxy.your-domain.com). Toggle SSL if using HTTPS. - SIP Port: Define the port (Default:
5060). - Generate: The system will create a Server ID and API Key. Save these.
- Endpoint: The URL (e.g.,
- Add Backend:
- Endpoint: The URL (e.g.,
http://10.0.0.5:5002). - SIP Port: Define the port (Default:
5080). - Generate: Save the Server ID and API Key.
- Endpoint: The URL (e.g.,
Register Background Node
Navigate to the Background Node tab (Top level of Infrastructure).
- Endpoint: The internal URL (e.g.,
http://background:80). - Generate: Save the API Key.
๐ 3. Complete Deployment
You now have the Server IDs and API Keys required by your worker nodes.
Action Required
Go back to your terminal.
- Return to the Application Deployment guide (Step 4).
- Update the
appsettings.json(or Environment Variables) for your Proxy, Backend, and Background apps with the IDs/Keys you just generated. - Start the services.
4. Verification
Once all services are running and green:
- Create User: Go to the User Dashboard and sign up a new standard user.
- Create Business: Create a workspace.
- Add Integration: Add a real OpenAI Key to the business.
- Test Call: Use the "Make Calls" button.
If the call connects, audio flows, and the AI responds, your self-hosted cluster is fully operational.