RisingWave Console

An On-Premise Observability and Management UI for RisingWave

A web-based interface to connect to, monitor, and manage your RisingWave clusters.

Note: You need a running RisingWave cluster to use RisingWave Console.

Installation

Method	Description	Use Case
Docker (Persistent)	Recommended way with data persistence	Production
Docker (Ephemeral)	Quick testing without persistence	Development/Testing
Standalone Binary	Download binary and run with your own PostgreSQL	Custom deployment
Docker Compose	Manage with Docker Compose	Production with self-managed PG
Kubernetes	Deploy on Kubernetes cluster	Cloud-native environments

Docker (Persistent) - Recommended

Run the following command:

docker run -d -p 8020:8020 --name risingwave-console \
  -e RCONSOLE_ROOT_PASSWORD=your_secure_password \
  -v risingwave-console-data:/var/lib/postgresql \
  risingwavelabs/risingwave-console:v0.5.0-pgbundle

Note: RCONSOLE_ROOT_PASSWORD sets the initial password for the root user. If not set, the default password is root.

Open http://localhost:8020 and login with:

• Username: root
• Password: your_secure_password

Docker (Ephemeral)

Quick testing without persistence. Metadata is lost if the container is removed.

docker run --rm -p 8020:8020 --name risingwave-console \
  risingwavelabs/risingwave-console:v0.5.0-pgbundle

Standalone Binary

Download and run with your own PostgreSQL instance.

curl https://risingwave-console.s3.ap-southeast-1.amazonaws.com/download.sh | sh
RCONSOLE_SERVER_PG_DSN="postgres://user:pass@host:port/dbname" \
RCONSOLE_ROOT_PASSWORD=your_secure_password ./risingwave-console

Docker Compose

Use Docker Compose to manage RisingWave Console and (optionally) a dedicated PostgreSQL container. See example in docker-compose.yaml, or our Installation Guide.

Kubernetes

Use Kubernetes to deploy RisingWave Console and all dependencies. See docker-compose-kubernetes.yaml and k0s.yaml for a full example.

Using RisingWave Console

1. Import Cluster: Go to "Clusters" → "Import" → Enter connection details (Host, SQL Port, Meta Node Port, HTTP Port, Version)

2. Explore Cluster: Click on a cluster to view details, execute risectl commands, manage snapshots, and collect diagnostics

3. SQL Console: Go to "SQL Console" → "Manage Databases" → Add database connection → Execute queries and explore schemas

Configuration

Configure using environment variables. See Configuration Guide for details.

Key variables: RCONSOLE_SERVER_PORT (default: 8020), RCONSOLE_SERVER_PG_DSN, RCONSOLE_ROOT_PASSWORD (default: root), RCONSOLE_RISECTLDIR

Documentation

For comprehensive guides and usage details, visit Official Documentation

Editions

• RisingWave Console-Lite: Open-source edition (Apache 2.0) with core functionalities (default)
• RisingWave Console-Pro: Enterprise edition with advanced capabilities (license required). Contact sales@risingwave-labs.com or apply here

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

RisingWave Console-Lite is licensed under the Apache License 2.0.