This project provides a user interface for the Lakekeeper REST catalog, designed to manage Apache Iceberg tables. It offers an intuitive and efficient way to interact with the catalog, simplifying the management of large datasets and supporting various data operations. The interface also facilitates fine-grained authorization, enabling users and roles to access system objects such as projects, warehouses, namespaces, tables, and views.
To set up this project, ensure you have the following:
- PostgresDB:
docker rm --force postgres-16 && docker run -d --name postgres-16 -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres:16.4 -c "max_connections=10000"- OpenFGA: For fine-grained authorization.
docker rm --force openfga && docker run -d --name openfga -p 35080:8080 -p 35081:8081 -p 35300:3000 openfga/openfga run- Identity Provider (IdP): For example, Keycloak or a similar solution. (see example https://github.com/lakekeeper/lakekeeper/tree/main/examples)
- Lakekeeper REST Catalog: Follow the setup instructions here.
Step-by-step instructions on how to get the development environment running.
# Clone the repository
git clone https://github.com/lakekeeper/console
# Navigate to the project directory
cd console
# Install dependencies
npm installInstructions and examples for using your project.
# Run the application
npm run dev
The console can show occasional, dismissible in-app surveys to help us understand how people use Lakekeeper and what to build next. We use Formbricks (Formbricks Cloud) for this.
What is sent
- An anonymous, randomly generated user ID created locally by the SDK (no email, no IP-based tracking by us, no warehouse/namespace/table names)
- The action key that triggered a survey (e.g.
warehouse_viewed) and a timestamp - Survey responses, only when a user voluntarily answers
What is not sent
- Catalog contents (warehouses, namespaces, tables, columns, queries)
- Authentication tokens or user profile data
- Any field that could identify the deployment beyond the SDK's anonymous ID
How to disable
Set LAKEKEEPER__UI__ENABLE_USER_SURVEYS=false (or VITE_ENABLE_USER_SURVEYS=false if building from source). When disabled, the Formbricks SDK is not initialized and no third-party requests are made.
This app uses @lakekeeper/console-components as its shared component library. For the full contributing guide — including local development setup, linking the library, and starting the backend — see:
console-components/CONTRIBUTING.md
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.