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. If required, you can configure the platform to use an HTTP proxy server and set up a port with a TLS certificate.

Before you begin

Copy GoogleWorkspaceMigrate_Platform_Installer (downloaded in the previous step) to the Windows server where you plan to install the platform.
Keep your Windows server updated, but we recommend turning off automatic updates during a migration so the process isn't interrupted.
Ensure the Windows server where you plan to install the Google Workspace Migrate platform has sufficient space. For details, see System requirements.
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 service account for authentication.

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

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

Expand section | Collapse all & go to top

Install the platform manually

On the Windows server for the platform:

Run GoogleWorkspaceMigrate_Platform_Installer as an administrator.
Select a language for the installer and click OK.
Accept the license agreement and click Next.
Choose where to install the Google Workspace Migrate platform and click Next.
Choose a start menu folder and click Next.
Select your additional shortcut options and click Next.
Enter a port number or accept the default port 5131 and click Next.
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.
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 Google Cloud console, you need to repeat the steps to create a new one. For details, see Create a service account for authentication.
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 service account for authentication.
Click Install.
After the installation, click Finish.

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

Install the platform using the command line

When you install from 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

On the Windows server:

Run PowerShell as administrator.
To install Google Workspace Migrate, enter the following command and any additional parameters (details below):
GoogleWorkspaceMigrate_Platform_Installer_version-number.exe /CLIENTID=client-ID /SERVICEACCOUNT=C:\path-to-service-account.json /ADMINEMAIL=admin-email
To start the Google Workspace Migrate platform service, enter the following command:
Start-Service -Name AppBridge.Local.ServiceHost
Open the Google Workspace Migrate management app from the Start menu. Alternatively, let the app reopen automatically when you restart Windows.

Command-line parameters

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

Parameter	Description
/ADMINEMAIL	Email address of a super administrator of your target Google Workspace account.
/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.
/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.
/NORESTART	(Optional) Prevents a system restart during installation.
/PORT	(Optional) Port number for the Google Workspace Migrate service (the default is 5131).
/SERVICEACCOUNT	Path to your service account's JSON file. For details, see Create a service account for authentication. Enclose the path in quotation marks if it contains spaces.
/SP-	(Optional) Turns off prompts at the beginning of a setup.
/SUPPRESSMSGBOXES	(Optional) Suppresses all message boxes.
/VERYSILENT	(Optional) Turns off the setup wizard and windows during the installation process.

Upgrading the platform

The CLIENTID, SERVICEACCOUNT, and ADMINEMAIL parameters aren't required for an upgrade unless you want to change these values.

Example:

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

Step 2: Complete any optional steps

Expand section | Collapse all & go to top

Set up the platform to use an HTTP proxy server

If you’re using a proxy server, on the server where you installed the platform:

Double-click the Google Workspace Migrate app.
On the taskbar, right-click Google Workspace Migrate and select Edit proxy settings.
Check Use a proxy server.
For Address, enter the proxy's address using the following format: http://proxy ip address:port.
Example: http://192.0.2.1:8888.
Click OK.
On the taskbar, right-click Google Workspace Migrate and select Stop Google Workspace Migrate service.
Right-click Google Workspace Migrate and select Start Google Workspace Migrate service.

If you change your network environment and remove the proxy server, repeat steps 1 and 2 above, uncheck Use a proxy server, and click OK.

Configure a port with a TLS certificate

We do not recommend using a self-signed certificate.

On the server where you installed the platform:

Import a TLS private key into the Windows personal certificate store. Consult your Microsoft documentation for details on importing a TLS private key.
If the certificate was issued by a certificate authority (CA) that isn't trusted by the computer, add the CA certificate to the Trusted Root Certification Authorities store. Consult your Microsoft documentation for details on how to place the certificate into the store.
As an administrator, open a command prompt.
To find the certificate thumbprint, enter the following command:
PowerShell -Command dir cert:\LocalMachine\My
From the list of certificates in the local machine's personal store, copy the thumbprint of the certificate that you want to use.
To configure the port, enter the following command:
netsh http add sslcert ipport=0.0.0.0:platform-port-number certhash=certificate-thumbprint appid= {3e3783f6-b92c-4546-8dee-672bf5c665ef}

Troubleshoot setup

To troubleshoot issues setting up or signing in to the Google Workspace Migrate platform, go to Troubleshoot platform issues.

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.}