First steps
This guide helps you quickly deploy CloudBeaver. Youāll launch the server, open the app in your browser, and prepare it for database connections.
Deploy CloudBeaver
The easiest way to run CloudBeaver is with Docker Compose:
Tip
You can also deploy CloudBeaver on Kubernetes, or in the cloud. See CloudBeaver deployment for more options.
-
Clone the deployment repo and navigate to the repository:
-
Copy the example file to create your
.env
file:Then open the file and make sure to change the default database password:
Tip
This file controls startup settings like ports, database config, and proxy type. See environment file variables and server configuration.
-
Start the server:
-
Open
http://<server-ip>:8978
in your browser to launch the easy config wizard.-
Follow the steps in the easy config wizard.
-
If youāre using a paid version, youāll need to provide your license key. Learn more
Need custom networking, HTTPS, or a proxy?
See Proxy configuration and Domain Manager.
-
-
Once setup is complete, continue with Basic operations.
Using the Community Edition?
See the CloudBeaver Community deployment instructions in the GitHub wiki.
Create a new connection
- Click the
+
button in the top menu and select New Connection. - Choose a driver.
-
Fill in connection details.
Info
See configuring connection settings for help.
-
Click Test to check the connection (optional).
- Click Create.
Resources for database operations
-
Interface overview
Overview of CloudBeaver's web interface. -
Database Navigator
Navigation through database schemas and objects. -
Database objects
Managing database objects. -
Data Editor
Data management and editing. -
Run queries
Running SQL queries and scripts. -
Database diagrams
Database structure visualization. -
Export data
Export tables, query results in different formats. -
Import data
Import data into databases from files in different formats. -
Use AI
AI features for database tasks.
Additional resources
-
DBeaver Blog
News and updates from the CloudBeaver team. -
Twitter updates
News and updates on Twitter. -
Edition comparison
Comparison of DBeaver editions.