> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment.md).

# On Premise Deployment

## Customising Service URLs

By default, the `@convai/experience-embed` library connects to Convai’s hosted backend services and virtual machines. However, for **on-premise development**, or enterprise setups, you may want to route traffic through your own backend and virtual machines.

To support this, you can override the default service URLs using the `serviceUrls` prop (React) or option (Vanilla/TS/CDN).

## Available Service URL Overrides

| Key               | Description                                                |
| ----------------- | ---------------------------------------------------------- |
| `sessionFetch`    | URL to fetch session data for the experience               |
| `pixelStreamBase` | Base URL where the Unreal Pixel Streaming server is hosted |

## React Example

```tsx
<PixelStreamComponent
  expId="your-experience-id"
  InitialScreen={<div>Loading...</div>}
  serviceUrls={{
    sessionFetch: 'https://your-backend.example.com/api/session',
    pixelStreamBase: 'https://your-streaming-server.example.com',
  }}
/>
```

## Vanilla JS Example

```ts
const pixelStream = new PixelStreamClient({
  container: document.getElementById('pixel-stream-container'),
  expId: 'your-experience-id',
  serviceUrls: {
    sessionFetch: 'https://your-backend.example.com/api/session',
    pixelStreamBase: 'https://your-streaming-server.example.com',
  }
});
```

## When to Use This

* You're running **Pixel Streaming servers locally** or on a **private cloud**.
* You want full control over **session management and security**.
* You are integrating the experience into a **larger enterprise application** with custom networking.

This flexibility allows the SDK to be integrated into diverse environments without requiring changes to the core library.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.