# UI Bakery on-premise

We understand that you might have lots of data accessible from your private network, that’s why you can use UI Bakery's self-hosted version for your benefit.

On-premise version grants you:

* Custom SAML/oAuth2 SSO (available in *Enterprise* plan);
* Custom branding (available in *Enterprise* plan);
* Custom domain hosting;
* Data is stored securely under your own VPS.

{% hint style="success" %}
UI Bakery on-premise version license key can be obtained [here](https://uibakery.io/on-premise-ui-bakery).
{% endhint %}

UI Bakery is also **SOC 2 compliant**, demonstrating our commitment to maintaining the highest standards of data security and operational integrity. Through our [Trust Portal](https://app.drata.com/trust/20bd3eb9-06a7-43c8-a64d-de309433e20a), you can request our latest SOC reports, penetration test (pentest) reports, and details about our internal security policies.

## Getting started

{% stepper %}
{% step %}

### Installation

Install the on-premise version following our [installation instructions](https://docs.uibakery.io/install-and-update/installing-on-premise-version#installation-steps) (for *Linux*).

For *other installation options*, check out our detailed guides [here](https://docs.uibakery.io/install-and-update/installing-on-premise-version#deployment-by-instance).
{% endstep %}

{% step %}

### Troubleshooting

Any issues during installation? They may already be described [here](https://docs.uibakery.io/on-premise/install-and-update/troubleshooting), check it out.
{% endstep %}

{% step %}

### Sign Up

Once the installation is complete, open the browser using the **URL** and **port** you provided during installation (by default, it is <http://localhost:3030/>).

By default, the **Login** page will open - navigate to the **Register** page (default - [http://localhost:3030/auth/register](http://localhost:3030/auth/register\).)). There, you need to sign up with your credentials - email and password.

{% hint style="info" %}
We recommend using your *work* email to sign up and create a workspace. You'll be the Admin of your workspace and you'll be able to invite your colleagues.
{% endhint %}
{% endstep %}

{% step %}

### Creating workspace

After signing up, you'll be prompted to create a new workspace where you can start building your apps.

{% hint style="warning" %}
It’s important to point out that your UI Bakery **cloud** version (if you have one) and UI Bakery **on-premise** are **not connected** in any way – they are not synchronized and are completely separate from each other.
{% endhint %}

Once you create your workspace, it will be empty without any apps that you might have in your cloud version. However, you can [export](https://docs.uibakery.io/concepts/export-import-an-app#exporting-an-application) your apps from cloud and [import](https://docs.uibakery.io/concepts/export-import-an-app#importing-an-application) them to the self-hosted version. It's also possible to [import a linked GitHub repository](https://docs.uibakery.io/concepts/export-import-an-app#importing-a-linked-github-repository).
{% endstep %}

{% step %}

### Inviting users

Our self-hosted version doesn't differ from the cloud in terms of app building, but the process of inviting users is a little bit different.

When inviting users here, they won't receive an email unless you've [set up email provider](https://docs.uibakery.io/on-premise/additional-configurations/email-configuration) to enable sending emails to users. If you haven't, then after inviting, you'll also need to send users a link to your workspace so that they will be able to register and get access to it.
{% endstep %}

{% step %}

### Updating on-premise

Once a week, we release on-premise updates and you don't want to miss out on them.&#x20;

Check out the guides below on updating your self-hosted version:

* [Updating on-premise](https://docs.uibakery.io/on-premise/install-and-update/updating-on-premise-version)
* [Updating license key](https://docs.uibakery.io/on-premise/install-and-update/updating-license-key)
* [Updating environment variables](https://docs.uibakery.io/on-premise/install-and-update/updating-environment-variables)
  {% endstep %}
  {% endstepper %}

Still got questions left? Don't hesitate to reach out to us at <support@uibakery.io>. Our team is always willing to help.

## Limitations

* The sending of emails will require [additional configuration](https://docs.uibakery.io/on-premise/additional-configurations/email-configuration) on the local instance, although the invitation system works so that any invited email can access the organization by creating an account.
* Google Sheets connection requires [additional setup](https://docs.uibakery.io/on-premise/additional-configurations/google-sheets-connection-setup).
* Salesforce connection requires [additional setup](https://docs.uibakery.io/on-premise/additional-configurations/salesforce-connection-setup).
* [Configuring blob storage](https://docs.uibakery.io/on-premise/additional-configurations/azure-blob-storage-configuration) is necessary for image component uploads.


---

# Agent Instructions: 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.uibakery.io/on-premise/ui-bakery-on-premise.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.
