Getting Started

Installation

Deploy the UnderOcean platform to your own infrastructure.

UnderOcean deploys as a self-contained set of services that run entirely on your own infrastructure — there is no dependency on a third-party managed cloud.

Prerequisites

  • A container-capable environment to run the platform's services
  • Access to the UnderOcean deployment package
  • At least one AI provider API key (OpenAI, Anthropic, etc.) — or a self-hosted model endpoint if you prefer not to use a hosted provider

1. Configure environment variables

Copy the provided environment template and fill in the required secrets: database credentials, token signing keys, the secret-encryption key used to protect stored provider credentials, and object storage credentials.

None of these have safe defaults — the platform will refuse to start with placeholder values.

Optional settings, such as public addresses and limits, are documented in the configuration template that ships with the deployment package.

Voice (optional): voice and phone gates need a few additional settings, listed in the same configuration template. Phone gates also need the server's public address, and the signaling and media ports must be reachable from your carriers directly (not through a web proxy).

2. Start the platform

Bring up the full stack. This provisions the database, cache, vector store, API, and frontend services.

3. Run database migrations

Apply the latest schema migrations before first use.

4. Open the app

Once running, the frontend and API become available at the addresses configured for your environment.

5. Enable the AI assistant (optional)

The AI assistant runs on a platform-operated model, so it stays off until a platform administrator sets one up: in Platform models add a model that supports tool calls and mark it active (and as the default, if every organization should get it), then optionally assign a model and a monthly token quota to an organization under its Assistant model tab. Usage per organization and month is listed under Assistant usage.

Continue to Quick Start to create your first organization, connect a provider, and run an agent.

On this page