Install & set up the platform

Next, install and set up the Google Workspace Migrate platform. To complete this task, install the platform on a Microsoft Windows server. Then, you can optionally configure a port on the platform server with a TLS certificate.

Before you begin

  • Ensure the Windows server where you plan to install the Google Workspace Migrate platform has sufficient space. For details, see System requirements
  • Copy GoogleWorkspaceMigrate_Platform_Installer that you downloaded in the previous step, to the Windows server where you plan to install the platform.
  • Disable Windows automatic updates on the server. 
  • Copy your service account key to the server. The key was created when you set up your service account. If you need to create it again, see Create a Google Workspace service account.

Step 1: Choose how to install & set up the platform

You can install the platform manually or using the command-line interface.

Install the platform manually

On the Windows server for the platform:

  1. Run GoogleWorkspaceMigrate_Platform_Installer as an administrator.
  2. Select a language for the installer and click OK
  3. Accept the license agreement and click Next.
  4. Choose where to install the Google Workspace Migrate platform and click Next.
  5. Choose a start menu folder and click Next.
  6. Select your additional shortcut options and click Next.
  7. Enter a port number or accept the default port 5131 and click Next.
  8. Enter your Google OAuth Client ID and click Next.

    You created the ID when you set up the Google Cloud Console. See Create the OAuth Web client ID.

  9. Click Browse, select the location of the JSON file that contains your service account key, and click Next.

    You created the JSON file when you created the Google Workspace service account. If you lost the file or deleted the key in the Cloud Console, you need to repeat the steps to create a new one. For details, see Create a Google Workspace service account

  10. Enter the email address of a super administrator of your target Google Workspace domain (where you’re migrating to) and click Next.

    Use the same email address as you used to authorize the service account. For details, see Create a Google Workspace service account

  11. Click Install.
  12. After the installation, click Finish.

Note: Record the host name or internal IP address of this Windows server. You’ll need it in a later step.

Install the platform using the command-line interface

To install the platform:

  1. On the Windows server for the platform, run PowerShell as administrator.
  2. Run the platform installer using the parameters from the tables below.

    Note: The installer automatically chooses the preselected setup options (below).

  3. After installation, enter the Start-Service -Name AppBridge.Local.ServiceHost command to start the Google Workspace Migrate platform service.
  4. Open the Google Workspace Migrate management app from the Start menu. Alternatively, let the app reopen automatically when you restart Windows.

Preselected setup options

When running on the command line, the installer automatically chooses these setup options:

  • Google Workspace Migrate install location (C:\Program Files\Google Workspace Migrate)
  • Start menu folder (Google Workspace Migrate)
  • Desktop shortcut created for all users
  • Google Workspace Migrate management app automatically opens when Windows starts

Command-line parameters

Parameter Description
/ClientID OAuth Web client ID that was created when you set up the Google Cloud Console. For details, see Create the OAuth Web client ID.
/ServiceAccount

Path to your service account's JSON file. For details, see Create a Google Workspace service account

Note: Enclose the path in quotation marks if it contains spaces.
/AdminEmail Email address of a super administrator of your target Google Workspace domain.
/Port (Optional) Port number for the Google Workspace Migrate  service (the default is 5131).
/Log

(Optional) File name of the log file. 

Creates a log file with output from the installer. If the installer doesn’t work as expected, you can view the log file for information.

 

To use the installer noninteractively, use the following command-line parameters:

Parameter Description
/SP- Turns off prompts at the beginning of a setup.
/VERYSILENT

Turns off the setup wizard and windows during the installation process.

/SUPPRESSMSGBOXES Suppresses all message boxes.
/NORESTART Prevents a system restart during installation.

Note: For more details on the command-line parameters available, consult the documentation for Inno Setup.

Examples

Install the platform:

.\GoogleWorkspaceMigrate_Platform_Installer_version-number.exe /SP- /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /ClientId=client-ID /ServiceAccount=C:\path-to-service-account.json /AdminEmail=admin-email

Here is an example for upgrading the platform. The ClientId, ServiceAccount, and AdminEmail parameters aren’t required for an upgrade unless you want to change these values:

.\GoogleWorkspaceMigrate_Platform_Installer_version-number.exe /SP- /VERYSILENT /SUPPRESSMSGBOXES /NORESTART

Step 2: Configure a port with a TLS certificate (Optional)

Note: We do not recommend using a self-signed certificate. 

On the server where you installed the platform:

  1. Import a TLS private key into the Windows personal certificate store. See your Microsoft documentation for details on importing a TLS private key.
  2. If your certificate doesn’t have a trusted certificate authority, put the certificate in the Trusted Root Certification Authorities store. See your Microsoft documentation for details on how to place the certificate into the store.
  3. To configure a port with the TLS certificate, in PowerShell, enter dir cert:\LocalMachine\My.

  4. From the list of certificates in the local machine’s personal store, copy the thumbprint of the certificate you want to use.
  5. In PowerShell, enter netsh http add sslcert ipport=0.0.0.0:<platform-port-number> certhash=<certificate thumbprint> appid= '{3e3783f6-b92c-4546-8dee-672bf5c665ef}'.

Next step

Install the node servers


Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.