UI Bakery On-Premise
Deploy UI Bakery locally to manage your data from your private network
We understand that you might have lots of data accessible from your private network, that’s why you can use UI Bakery self-hosted version for your benefit.
On-premise version grants you:
  • The relatively quick setup process;
  • Custom branding;
  • Custom domain hosting;
  • Google SSO;
  • Data is stored securely under your own VPS
To obtain UI Bakery on-premise version and installation instructions, please email us at [email protected] or message us in Live Chat

Installation

  1. 1.
    Install docker https://docs.docker.com/engine/install/
  2. 2.
    Open cd ui-bakery-on-premise folder in the terminal
  3. 3.
    Run docker-compose up to start the containers, alternatively, docker-compose up -d to run containers in the background
  4. 4.
    Wait until all containers are up and running
  5. 5.
    Open localhost:3030 or SERVER_HOST:3030 to access UI Bakery instance, then you can create a new account

Running a standalone database instance

In case when a 3rd party MySQL instance is required:
  1. 1.
    Provide the following environment variables:
1
UI_BAKERY_DB_HOST=192.168.0.1
2
UI_BAKERY_DB_PORT=3306
3
UI_BAKERY_DB_DATABASE=bakery
4
UI_BAKERY_DB_USERNAME=username
5
UI_BAKERY_DB_PASSWORD=password
Copied!
2. Run docker-compose -f ./docker-compose-external-db.yml up to start the containers, alternatively, docker-compose -f ./docker-compose-external-db.yml up -d to run containers in the background
3. Wait until all containers are up and running
4. Open localhost:3030 or UI_BAKERY_APP_SERVER_NAME:3030 to access UI Bakery instance, then you can create a new account

Google OAuth setup

  1. 1.
    Create OAuth Client ID in Google developer console
    a. Create or choose an existing project
    b. Click on “Create credentials”
    c. Choose “OAuth Client ID”
    d. Choose “Web Application” Application type
    e. Specify http://localhost:3030 or UI_BAKERY_APP_SERVER_NAME for authorized javascript origin
    f. Specify http://localhost:3030/auth/oauth2/callback or UI_BAKERY_APP_SERVER_NAME/auth/oauth2/callback for authorized redirect URLs
    g. Click “Create”
    h. Copy “Your Client ID”
  2. 2.
    Provide UI_BAKERY_GOOGLE_CLIENT_ID=Your Client ID environment variable
  3. 3.
    Provide UI_BAKERY_APP_SERVER_NAME=http(s)://youdomain.com environment variable in case you want to run UI Bakery on a custom domain/IP
  4. 4.
    Run docker-compose up if you want to use the embedded database
  5. 5.
    Or run docker-compose -f ./docker-compose-external-db.yml up with environment variables described in Running a standalone database instance above in case you want to use an external database

Auth settings

  1. 1.
    You can disable email authentication by providing the environment variable UI_BAKERY_GOOGLE_AUTH_ONLY=true
  2. 2.
    Provide UI_BAKERY_AUTH_RESTRICTED_DOMAIN=domain.com environment variable to restrict Google login only to the specified domain

Limitations

  • Emails won’t be sent from the local instance, although the invitation system works in a way that any invited email can access the organization by creating an account.
  • Google Spreadsheet connection requires additional setup if necessary
Please note that update is handled by request. To receive an update, please email us at [email protected] or message us in Live Chat
Last modified 1mo ago