OLake UI

OLake UI is a web-based interface for managing OLake jobs, sources, destinations, and configurations. It provides an easy way to create, edit, and monitor jobs without needing to interact with the command line.

info

Refer to OLake User Interface (UI) GitHub repository for more information.

Refer to Jobs documentation for more details on how to create and manage jobs using the OLake UI.

Running with Docker Compose

You can run the entire OLake stack (UI, Backend, Temporal worker, Temporal services, and dependencies) using Docker Compose. This is the recommended way to get started for local development or evaluation.

Prerequisites

• Docker installed (Docker Desktop recommended for Mac/Windows)
• Docker Compose (comes with Docker Desktop)

Quick Start

1. Clone the repository:

   git clone https://github.com/datazip-inc/olake-ui.git
   cd olake-ui

2. Customizing Admin User (optional):

   The stack automatically creates an initial admin user on first startup. The default credentials are:

   • Username: "admin"
   • Password: "password"
   • Email: "test@example.com"

   To change these defaults, edit the x-signup-defaults section in your docker-compose.yml:

   x-signup-defaults:
   username: &defaultUsername "your-custom-username"
   password: &defaultPassword "your-secure-password"
   email: &defaultEmail "your-email@example.com"

3. Start all services:

   docker compose up -d

4. Check that everything is running:

   docker compose ps

5. Access the services:

   • Frontend UI: http://localhost:8000

6. Stopping the stack:

   docker compose down

7. Use credentials admin / password to log in to the UI.

Notes

• The first time you run, Docker will pull all required images.
• Data and configuration are persisted in the directory you set in docker-compose.yml at Step 2.
• The Temporal worker requires access to the Docker socket to launch containers for jobs. This is handled by the volume mount in the compose file.

Next Steps

1. Create a Job, this includes:
   • Setting up a source (e.g., PostgreSQL, MySQL, etc.)
   • Setting up a destination (e.g., OLake, OLake UI, etc.)
   • Configuring the streams to sync
   • Configuring the job settings
2. Monitor job status and logs through the UI.

Troubleshooting

• If you see errors about file permissions, ensure your host persistence/config directory is writable by Docker.
• For more logs, use:

  docker-compose logs -f
• If you change the code or configuration, you may need to rebuild images:

  docker-compose build
  docker-compose up -d