Install

Perform the following steps to install yb-voyager using apt for Ubuntu:

1. Install the Yugabyte apt repository on your machine using the following command:

   wget https://s3.us-west-2.amazonaws.com/downloads.yugabyte.com/repos/reporpms/yb-apt-repo_1.0.0_all.deb
   sudo apt-get install ./yb-apt-repo_1.0.0_all.deb
   

   This repository contains the yb-voyager Debian package and the dependencies required to run yb-voyager.

2. Install the postgresql-common repository to fetch PostgreSQL 16 using the following commands:

   sudo apt install -y postgresql-common
   sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
   

3. Clean the apt-get cache and package lists using the following commands:

   sudo apt-get clean
   sudo apt-get update
   

4. Install yb-voyager and its dependencies using the following command:

   sudo apt-get install yb-voyager
   

   Note: If you see a failure in the install step similar to the following:

   Depends: ora2pg (= 23.2-yb.2) but 24.3-1.pgdg22.04+1 is to be installed
   

   Try installing ora2pg using the following command:

   sudo apt-get install ora2pg=23.2-yb.2
   

   Then try installing yb-voyager using the following command:

   sudo apt-get install yb-voyager
   

5. Check that yb-voyager is installed using the following command:

   yb-voyager version
   

Upgrade yb-voyager

sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh

Upgrade yb-voyager using the following command:

sudo apt-get upgrade yb-voyager

Perform the following steps to install yb-voyager using brew for macOS:

1. Tap the yugabyte Homebrew repository using the following command:

   brew tap yugabyte/tap
   

   The repository contains the formula to build and install yb-voyager on your macOS device.

   Note that the tap yugabyte/yugabytedb has been updated to yugabyte/tap. If you have previously installed yb-voyager using the tap yugabyte/yugabytedb, untap the entry using brew untap yugabyte/yugabytedb, and then tap using the preceding command.

2. Install the postgresql@16 package to access pg_dump or pg_restore using the following command:

   brew install postgresql@16
   

3. Install yb-voyager and its dependencies using the following command:

   brew install yb-voyager
   

   Install a specific version of yb-voyager using the following command:

   brew install yb-voyager@<VERSION>
   

4. Check that yb-voyager is installed using the following command:

   yb-voyager version
   

• Docker
• Yum
• Ubuntu

./install-voyager-airgapped.sh [options]

./install-voyager-airgapped.sh [options]

Before installing yb-voyager, ensure that you have the Docker runtime installed on your machine.

1. Pull the docker image from YugabyteDB's docker hub (Pull the version from docker.io) as follows:

   docker pull yugabytedb/yb-voyager
   

2. Download the script to run yb-voyager using the docker image from yb-voyager's GitHub repository, and move it to your machine's bin directory using the following commands:

   wget -O ./yb-voyager https://raw.githubusercontent.com/yugabyte/yb-voyager/main/docker/yb-voyager-docker && chmod +x ./yb-voyager && sudo mv yb-voyager /usr/local/bin/yb-voyager
   

   Use yb-voyager docker script without sudo to run Voyager commands. To do this you need to reconfigure docker on your system to run without sudo. Refer to Manage Docker as a non-root user in the Docker documentation.

3. Check that yb-voyager is installed using the following command:

   yb-voyager version
   

Perform the following steps to install yb_voyager using an installer script:

1. Clone the yb-voyager repository.

   git clone https://github.com/yugabyte/yb-voyager.git
   

2. Change the directory to yb-voyager/installer_scripts.

   cd yb-voyager/installer_scripts
   

3. Install yb-voyager using the following script:

   ./install-yb-voyager
   

   It is safe to execute the script multiple times. If the script fails, check the /tmp/install-yb-voyager.log file.

4. The script generates a .yb-voyager.rc file in the home directory. Source the file to ensure that the environment variables are set using the following command:

   source ~/.yb-voyager.rc
   

5. Check that yb-voyager is installed using the following command:

   yb-voyager version