Get Started with Liquibase Hub

Liquibase Hub is a secure portal that provides real-time monitoring, reports, and insights into your team's database release automation. It provides centralized visibility into distributed Liquibase operations performed against multiple environments.

The Liquibase CLI app sends information to the Liquibase Hub portal when you run commands that make changes to your database.

Liquibase Hub workflow

The diagram below represents the following actions:

  1. Join Liquibase Hub and add API Key to the Liquibase properties file or defaults.
  2. Register a changelog file to a Liquibase Hub project.
  3. Run the commands tracked by Liquibase Hub. For example, update, rollback, changelog-sync, or drop-all.
  4. When successful, the local DBCL table is synchronized with Liquibase Hub for Operation reports.

Sign up for an account

  1. Go to the Liquibase Hub portal.
  2. Sign up for an account.
  3. Check your email and click a verification link to activate the account.

Install Liquibase

Tip: If you have already installed Liquibase, skip this step.

Click Download Liquibase and run the installer.

Note: Liquibase automatically detects your operating system and specific installation files to download. To use another operating system, go to the Download page. If you encounter any issues, check the Installation Troubleshooting page.

If you are new to Liquibase, see Getting Started with Liquibase.

Configure Liquibase Hub

From the command prompt or terminal, run the liquibase init hub command with the token you see in the Liquibase Hub dialog and follow the CLI instructions depending on the database:

  • To use the H2 database that is included with the Liquibase installation files, enter Y for the default settings.
  • To use your database, enter C and customize the username, password, and database URL parameters. After running the command, check or add a database driver.

Note: The command connects your local Liquibase activity to Liquibase Hub with an API key and set up the Liquibase environment. If you are new to Liquibase, the init hub command creates configuration files for you.

Tip: If you encounter issues with a token or environment setup, configure Liquibase Hub manually with the register-changelog command.

Tip: Alternatively, you can auto-register for Liquibase Hub when you run the update command. See Liquibase Hub Auto-Registration and Report Links .

Deploy your first change

  • Navigate to the registered Liquibase project directory and run the following command:
  • Note: To use the in-memory H2 database, open a new terminal window and run the liquibase init start-h2 command before running the update command.

    liquibase update
  • Open your Liquibase Hub report to see the update details.

Next steps

To learn Liquibase Hub concepts, check the following pages:

To connect more files to Liquibase Hub:

  1. Add a Liquibase Hub API key to the the Liquibase properties file
  2. Run the register-changelog command
  3. Run your regular commands

Related Links