Articles in this section

User Setup (Mac)

This article explains how to install and register a Mac as a GoodSync Control Center Runner.

Important: A Company PIN is required when registering a new Runner. All installation examples below include the required /cc-copin parameter.

Existing registered Runners do not need to be reinstalled or registered again.

Step 1: Download the Mac Runner

Download the GoodSync Control Center Runner installer for Mac: GoodSync CC Runner for Mac

Step 2: Locate Your Company ID and Company PIN

Open https://jobs.goodsync.com/ and sign in to your company account.

Locate your Company ID under the Settings tab in GoodSync Control Center.

Your Company ID identifies the Control Center company to which the Runner will register.

GoodSync Control Center Settings page

Company PIN: If your company already has a PIN configured, use that PIN when installing new Runners.

If no Company PIN has been configured, a Control Center administrator must create one:

  1. Open Settings.
  2. Select Company Settings.
  3. Click Edit Company Settings.
  4. Enter a Company PIN and save your changes.

New Company PINs must contain 8–20 letters or numbers.

Note: The Company PIN is different from your GoodSync account password. Both are required for installations using Account Sync.

Step 3: Open Terminal

Open Terminal on your Mac and navigate to the folder where the installer was downloaded.

By default, this will typically be the Downloads folder.

Use the cd command to navigate through directories and the ls command to view the files in your current location.

Mac Terminal showing installer directory

Step 4: Grant Installer Permissions

Once you are in the folder containing the installer, grant it execution permissions using the following command:

chmod +x ./goodsync-vsub-cc-runner-mac.sh

If the command completes successfully, no confirmation message is normally displayed.

You can now run the installer using one of the following setup methods.

Step 5: Install the Mac Runner

There are two ways to install the GoodSync Control Center Runner on macOS:

1) User: The Runner starts after the Mac user logs in.

2) Service: The Runner starts after the system boots and operates under the specified Mac user account.

Important: Replace YOUR_COMPANY_ID, YOUR_COMPANY_PIN, and the GoodSync account information with your actual values before running the installer.

User Installation

Use the following command to install the Runner in User mode:

./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=YOUR_COMPANY_ID /cc-copin=YOUR_COMPANY_PIN /gs-userid=YOUR_GOODSYNC_USER_ID /gs-pwd=YOUR_GOODSYNC_PASSWORD

Example:

./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=12345 /cc-copin=12345678 /gs-userid=yourcompany-companydomain-com /gs-pwd=YOUR_GOODSYNC_PASSWORD

The GoodSync User ID can be found under the Administrators tab in Control Center or in your GoodSync account.

For example, a GoodSync account using yourcompany@companydomain.com may have a User ID similar to yourcompany-companydomain-com.

Note: The word user in /cc-runner=user must not be replaced with an actual Mac username.

For example, /cc-runner=john is incorrect.

Combined Installation Command

You can also grant execution permissions and run the installer using a single command:

chmod +x ./goodsync-vsub-cc-runner-mac.sh && ./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=YOUR_COMPANY_ID /cc-copin=YOUR_COMPANY_PIN /gs-userid=YOUR_GOODSYNC_USER_ID /gs-pwd=YOUR_GOODSYNC_PASSWORD

This command first grants execution permissions and then starts the Runner installation.

Service Installation

Use the following command to install the Runner as a service that starts after the Mac boots:

sudo ./goodsync-vsub-cc-runner-mac.sh /cc-runner=service /cc-coid=YOUR_COMPANY_ID /cc-copin=YOUR_COMPANY_PIN /sys-userid=YOUR_MAC_USER /gs-userid=YOUR_GOODSYNC_USER_ID /gs-pwd=YOUR_GOODSYNC_PASSWORD

Example:

sudo ./goodsync-vsub-cc-runner-mac.sh /cc-runner=service /cc-coid=12345 /cc-copin=12345678 /sys-userid=macuser /gs-userid=yourcompany-companydomain-com /gs-pwd=YOUR_GOODSYNC_PASSWORD

When using /cc-runner=service, specify /sys-userid so the Runner operates under the intended Mac user account.

The sudo command may prompt for your Mac administrator password.

Mac Runner installation command

Important: The Company PIN is required for both User and Service installations.

Self-Hosted Control Center

If using an existing self-hosted Control Center, include the /cc-url parameter to specify your Control Center server address.

./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=YOUR_COMPANY_ID /cc-copin=YOUR_COMPANY_PIN /gs-userid=YOUR_GOODSYNC_USER_ID /gs-pwd=YOUR_GOODSYNC_PASSWORD /cc-url=http://YOUR_SERVER_IP

Replace the example server address with the address of your self-hosted Control Center.

Note: Self-hosted Control Center is no longer offered for new purchases.

Parameters and Options

The following parameters are available when installing the GoodSync Control Center Runner on Mac.

Required Parameters

  • /cc-coid=CompanyID – Specifies the Company ID used to register the Runner with Control Center.
  • /cc-copin=YourCompanyPIN – Specifies the Company PIN required when registering a new Runner.
  • /cc-runner=user|service – Specifies how the Runner starts.
    • user – Starts the Runner after the Mac user logs in.
    • service – Starts the Runner after system boot under the specified Mac user account.
  • /gs-userid=GoodSyncUserID – Specifies the GoodSync User ID used for Account Sync.
  • /gs-pwd=GoodSyncPassword – Specifies the GoodSync account password used for Account Sync.

Note: Starting with Control Center 3.2, new installations using Account Sync require both /gs-userid and /gs-pwd.

Use the GoodSync User ID associated with your Control Center company.

Additional Parameters

  • /sys-userid=MacUser – Specifies the Mac user account under which the Runner operates in Service mode.
  • /cc-url=ServerURL – Specifies a custom Control Center server URL. 
    Default: https://jobs.goodsync.com/
  • /cc-allow-bad-certs – Allows connections using SSL certificates that would otherwise fail validation. Use only in a trusted environment when necessary.
  • /cc-proxy=Host – Specifies a proxy server. Supports host or host:port.
  • /cc-proxy-auth=Login:Password – Specifies authentication credentials for the configured proxy.
  • /cc-server-license – Forces the Runner to use a Server license.
  • /? – Displays the installer help message and available parameters.

Security Note: Installation commands containing Company PINs or account passwords should only be accessible to authorized administrators.

Step 6: Verify the Runner Installation

Once the installation is complete, open GoodSync Control Center.

Navigate to the Runners tab. Your Mac should appear in the list of registered Runners.

Mac Runner listed in GoodSync Control Center

Step 7: Authorize the New Runner

Before the Runner can receive and execute assigned jobs, it must be authorized in GoodSync Control Center.

  1. Open the Runners tab.
  2. Locate the newly registered Mac Runner.
  3. Select the checkbox next to the Runner.
  4. Click Actions > Authorize.
  5. Save the changes.

Once authorized, the Runner should display Authorized: True.

After the Runner connects successfully, its status should display as Online.

Your Mac is now connected to GoodSync Control Center and ready to receive assigned jobs.

Troubleshooting

The Runner Is Not Showing in Control Center

If the installation completes successfully but the Runner does not appear in Control Center, verify the following:

  • Confirm that the correct Company ID was used during installation.
  • Confirm that the correct Company PIN was provided.
  • Verify that the GoodSync User ID is associated with the correct Control Center company.
  • Confirm that the Mac can connect to the Control Center server.
  • Check whether the Runner is already registered in Control Center.

If the Runner was previously registered and its local configuration is missing or damaged, an administrator may need to remove the old Runner registration from Control Center before registering it again.

The local Runner configuration includes the enterprise-runner.tix file, located in the hidden /Users/YourUserAccount/.goodsync folder.

Important: Do not delete the Runner configuration file from an existing registered Runner without first reviewing its registration status in Control Center.

The period at the beginning of .goodsync indicates that it is a hidden folder.

How Can I Tell If the Runner Is Active?

Runner logs are written to the following folder:

/Users/useraccount/.goodsync

Replace useraccount with your Mac username.

If the Runner is active, you should see a current Runner log in this folder. Review the log to confirm activity and check for any errors.

You can also check whether the Runner process is running using Terminal:

ps aux | grep gsync

If the Runner is active, the command should display the running GoodSync process.

How Can I Manually Restart the Runner?

If the Runner has already been installed but is not active, you can manually start the Runner using the following command:

"/Users/useraccount/Library/Application Support/GoodSync/gsync" /runner-service=main-runner &

Replace useraccount with the Mac user account under which GoodSync was installed.

After starting the Runner, return to GoodSync Control Center and verify that the device appears as Online.

Back to top ↑

Related articles

Powered by Zendesk