> ## Documentation Index
> Fetch the complete documentation index at: https://ryvn.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Ryvn BYOC

> Run a dedicated Ryvn control plane (hub) inside your own cloud account, provisioned and kept up to date by Ryvn.

Most teams use the hosted Ryvn control plane at `ryvn.app` to deploy into their own cloud and into their customers'
clouds. Ryvn BYOC goes one step further: the control plane itself, the **hub**, runs in a cloud account that you own.
Your deployment metadata, credentials and audit history stay inside your boundary, while Ryvn continues to provision,
upgrade and operate the hub for you.

## How it works

```text theme={null}
Ryvn (SaaS control plane)
  |  provisions and manages
  v
your cloud account
  +-- dedicated project / account for the hub
  +-- Kubernetes cluster, database, secrets, ingress
  +-- Ryvn hub: API, dashboard, auth, git sync, release workflows
        |  deploys to
        v
      your environments and your customers' environments
```

* **You own the account.** You create a dedicated project or account and grant Ryvn scoped access to manage it. You can
  see and audit everything Ryvn creates there.
* **Ryvn operates it.** Provisioning, upgrades and monitoring of the hub are handled by Ryvn, the same way the hosted
  control plane is run.
* **Same product.** The dashboard, CLI, API and git sync work exactly as they do on the hosted control plane. Your hub
  has its own domain, for example `https://acme.ryvn-abc12.ryvn.run`, and its own API at `https://api.<hub domain>`.
* **Your integrations.** Because the hub lives in your account, integrations such as GitHub are connected through
  credentials that you own and can revoke.

## Setting up a dedicated hub

Ryvn walks you through onboarding. The pieces you complete on your side are:

<Steps>
  <Step title="Create the cloud project or account">
    Create an empty project (GCP) or account (AWS) for the hub and grant Ryvn the access it asks for. Ryvn provisions
    everything inside it.
  </Step>

  <Step title="Connect GitHub">
    Create a GitHub App in your organization for the hub and hand the generated credentials to Ryvn. Follow
    [Set up the GitHub App for your dedicated Ryvn hub](/docs/ryvn-byoc/github-app).
  </Step>

  <Step title="Connect your identity provider (optional)">
    To sign in with your own identity provider, create an OIDC application for the hub and hand the issuer and client
    credentials to Ryvn. Follow [Set up the Okta app for your dedicated Ryvn hub](/docs/ryvn-byoc/okta-app).
  </Step>

  <Step title="Connect Slack notifications (optional)">
    Create a Slack app in your workspace for the hub and hand the client credentials to Ryvn. Once the integration is
    enabled, connect a notification channel from your hub. Follow
    [Set up the Slack app for your dedicated Ryvn hub](/docs/ryvn-byoc/slack-app).
  </Step>

  <Step title="Sign in and invite your team">
    Once Ryvn confirms the hub is up, sign in at your hub domain, install the GitHub App on the repositories Ryvn should
    manage and invite your team. From here on the [quickstart](/docs/quickstart) applies unchanged.
  </Step>
</Steps>

<Note>
  Ryvn BYOC is available to customers with a dedicated-hub agreement. Talk to your Ryvn contact if you want a hub in
  your own account.
</Note>
