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

# Admin Setup

> Get Ultra running in seconds

<Tabs>
  <Tab title="Download from Website">
    <Steps>
      <Step title="Download and install Ultra">
        Visit [ultra.security](https://ultra.security) and download the installer for your platform. The website provides signed macOS `.pkg` installers and Linux binaries.

        Run the installer — it will automatically detect your AI clients and configure them.
      </Step>

      <Step title="Restart your AI client">
        **Quit and reopen** your AI client (Claude Desktop, Cursor, Codex, etc.) so it picks up the Ultra connection.

        Ultra works with **Claude Desktop**, **Cursor**, **VS Code**, **GitHub Copilot**, **Claude Code**, **Codex**, **Windsurf**, **Roo Code**, **Goose**, **Gemini**, **Antigravity**, **LM Studio**, **Amazon Q Developer**, **Zed**, **Ona**, and **Hermes**.
      </Step>

      <Step title="Verify it's working">
        Ask your AI client to check the connection:

        * *"Check your connection to Ultra"*

        Your client should confirm that Ultra is installed and running.
      </Step>

      <Step title="Connect to MCP servers">
        Ask your AI client to add the MCP servers you want to use:

        * *"Connect to the Notion MCP server"*
        * *"Add the GitHub MCP server"*
        * *"Set up the Linear MCP server"*
        * *"Add the filesystem server so you can read my project files"*

        Your client will search the registry, install the server, and handle any authentication setup.

        **Restart your AI client** after adding servers for them to become available.

        <Warning>
          Make sure your client installs the **official** MCP server for each service — not a community fork. If unsure, ask your client to confirm the publisher before installing.
        </Warning>
      </Step>

      <Step title="Connect to Ultra Hub">
        For centralized team management:

        1. Go to [hub.ultra.security](https://hub.ultra.security) and create an account
        2. Create a **workspace** for your team
        3. Ask your AI client to connect:
           * *"Log in to Ultra Hub"*
           * *"Link this gateway to Ultra Hub"*

        Once linked, your traces and audit events sync to Ultra Hub for team-wide visibility.
      </Step>

      <Step title="Invite your team">
        From the Hub web UI:

        1. Go to **Settings > Invites**
        2. Click **Invite Member**
        3. Enter the team member's email address and select a role
        4. Click **Send Invite**

        The invited user receives an email with a link to join your organization. See [Roles & Permissions](/hub/rbac) for details on available roles.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Terminal">
    <Steps>
      <Step title="Install Ultra">
        ```bash theme={null}
        curl -sSL https://get.ultra.security/install.sh | sh
        ```

        This auto-detects your OS and architecture, downloads the latest release from CDN, and installs the `ultra` binary to `/usr/local/bin`.

        <Accordion title="Other installation methods">
          **macOS .pkg installer:**
          Download the signed and notarized `.pkg` from `get.ultra.security/v{VERSION}/Ultra-{VERSION}-macOS.pkg` and double-click to install.

          **Custom install directory:**

          ```bash theme={null}
          INSTALL_DIR=~/.local/bin curl -sSL https://get.ultra.security/install.sh | sh
          ```

          See [Installation](/installation/install-ultra) for all options.
        </Accordion>
      </Step>

      <Step title="Run diagnostics">
        Verify that Ultra is installed and your system is ready:

        ```bash theme={null}
        ultra doctor
        ```

        This checks your OS, detects installed MCP clients, and validates dependencies like Node.js.
      </Step>

      <Step title="Configure your MCP client">
        Run the interactive install wizard to configure your MCP client to use Ultra:

        ```bash theme={null}
        ultra install
        ```

        <Tabs>
          <Tab title="Claude Desktop">
            ```bash theme={null}
            ultra install --client claude
            ```

            This configures Claude Desktop to route all MCP traffic through Ultra.
          </Tab>

          <Tab title="Cursor">
            ```bash theme={null}
            ultra install --client cursor
            ```
          </Tab>

          <Tab title="Codex">
            ```bash theme={null}
            ultra install --client codex
            ```

            This configures Codex to route all MCP traffic through Ultra.
          </Tab>

          <Tab title="Non-interactive">
            ```bash theme={null}
            ultra install --yes
            ```

            Installs into all detected clients without prompting.
          </Tab>
        </Tabs>

        **Restart your MCP client** after configuring for changes to take effect.
      </Step>

      <Step title="Add an MCP server">
        Search the registry and add a server:

        ```bash theme={null}
        ultra search filesystem
        ultra add @modelcontextprotocol/server-filesystem
        ```

        Ultra searches the official MCP Registry and npm, then adds the server to your configuration. You can also add remote servers by URL:

        ```bash theme={null}
        ultra add https://mcp.example.com/sse
        ```

        **Restart your MCP client** after adding servers.
      </Step>

      <Step title="Start the proxy">
        Start Ultra — your MCP client connects to Ultra, and Ultra proxies to your upstream servers:

        ```bash theme={null}
        ultra start
        ```

        Ultra is now recording every MCP operation. Restart your MCP client to begin routing traffic through Ultra.
      </Step>

      <Step title="Connect to Ultra Hub">
        For centralized team management:

        1. Go to [hub.ultra.security](https://hub.ultra.security) and create an account
        2. Create a **workspace** for your team
        3. Authenticate and link your gateway:

        ```bash theme={null}
        ultra login
        ultra link
        ```

        Once linked, your traces and audit events sync to Ultra Hub for team-wide visibility.
      </Step>

      <Step title="Invite your team">
        From the Hub web UI:

        1. Go to **Settings > Invites**
        2. Click **Invite Member**
        3. Enter the team member's email address and select a role
        4. Click **Send Invite**

        The invited user receives an email with a link to join your organization. See [Roles & Permissions](/hub/rbac) for details on available roles.
      </Step>

      <Step title="(Optional) View local traces">
        Open the local web dashboard to see your MCP traffic:

        ```bash theme={null}
        ultra dashboard
        ```

        Navigate to `http://localhost:8080` to inspect traces, view audit logs, and monitor connected servers locally.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## What's Next

<CardGroup cols={2}>
  <Card title="How It Works" icon="diagram-project" href="/how-it-works">
    Understand the proxy architecture
  </Card>

  <Card title="Configuration" icon="gear" href="/configuration/config-file">
    Customize your Ultra setup
  </Card>

  <Card title="Observability" icon="eye" href="/observability/overview">
    Deep dive into traces and audit logs
  </Card>

  <Card title="Ultra Hub" icon="tower-control" href="/hub/overview">
    Set up team management
  </Card>
</CardGroup>