GoodSync Control Center Manual

Applies to GoodSync for Windows, Mac, Linux, and NAS unless noted otherwise.

GoodSync Control Center Manual

• Introduction
• Administrator Guide
• Company Creation
• Navigation
• Dashboard
• Getting Started
• Job Runners
  • Authorizing Runners
  • Runner Details
  • Adding Runners to Groups
  • Assigning Runners to Jobs
  • Runner Bulk Actions
• Runner Groups
  • Creating Groups
  • Group Details
  • Adding Runners to Group
  • Assigning Groups to Jobs
  • Group Bulk Actions
• Jobs
  • Creating Jobs
  • Job Details
  • Assigning Jobs to Runner Groups
  • Assigning Jobs to Runners
  • Running Jobs
  • Job Bulk Actions
  • Job Special Operations
  • Uploading Jobs to the Control Center
• Server Accounts
  • Uploading Accounts to the Control Center
  • Using Accounts in Jobs
• Job Runs
• Reports
• Administrators
  • Creating Administrators
  • Administrator Bulk Actions
• Settings
  • Company Settings
  • Personal Settings
  • Global Runner Options
  • License Information
  • Company Administrators Sessions
  • Company Administrators Sessions History
• Runner Deployment
• Getting Company ID
• Deploying Runners on Windows
  • Installer Parameters and Options
  • Runner Mass Deployment
• Deploying Runners on Mac
  • Installer Parameters and Options
• Deploying Runners on Linux/NAS
• Deploying Runners on Android

Introduction

GoodSync facilitates the synchronization of two or more folders containing files, ensuring their consistent alignment. This process involves copying new or modified files from the source folder to the destination folder and, when needed, removing files to maintain identical content between the folders.

GoodSync Control Center centralizes the management of all GoodSync Clients (Windows, Mac, Linux, NAS, Server, Workstation), centrally distributes GoodSync Jobs, and Reports on Job Run statuses.

For more information about GoodSync, what it can do, and how to use it, please see the GoodSync Manual.

Back to the Top

Administrator Guide

The GoodSync Control Center is an online service designed to enable companies to create and oversee jobs for runners installed on client devices. All company management tasks are performed online and are seamlessly integrated with GoodSync Workstation and Server installations.

To set up your company effectively, an administrative user should initiate the company creation process. Subsequently, runners are added to the company. Once authorized, these runners will be assigned specific jobs. Runners organized into groups will collectively receive all jobs designated for that particular runner group. As jobs are executed, their status is relayed back to the Control Center, providing a centralized platform for effortless monitoring and reporting.

Getting started with the GoodSync Control Center is easy. Follow the steps below from top to bottom.

Back to the Top

Company Creation

1. Start by creating a Company Account here:
   https://jobs.goodsync.com/ui/signup
2. Fill in the form information provided.
   
   
   
3. Click "Submit" to submit the Company information.
4. Once the Company Account is created, log in and proceed.
   
   
   

Back to the Top

Navigation

After logging in, the Control Center Dashboard will be displayed. It presents with a navigation menu on the left:

• Dashboard contains global Company information, including Job Run errors, non-running Jobs, and basic Control Center Statistics.
• Getting Started introduces the GoodSync Control Center and provides quick-start instructions.
• Job Runners are a combination of a specific User from a specific Computer. Runners are approved (authorized) by the Administrator before Jobs are sent to them.
• Runner Groups are Groups of Runners that can be assigned to the Jobs.
• Jobs lists all GoodSync Jobs available through the Control Center. The Administrator may add/remove and edit all Job Options and assign Runners and Groups to Jobs.
• Server Accounts lists a read-only view of all uploaded Server Accounts available for Jobs within the Control Center. Administrators may upload Accounts from the GoodSync GUI.
• Job Runs show detailed GoodSync Job information on all backups and synchronizations for all Runners.
• Reports show compiled Job information on specific backups and sync for all Runners.
• Administrators allow management of Company Administrators.
• Settings contain global settings for the Control Center, including Global Job Options, Authorization settings, Administrator settings, etc.
• Documentation refers to this Manual.

Back to the Top

Dashboard

At the top, see the Control Center figures: the number of licensed and authorized Workstation and Server Runners and the license expiration date.

Purchase licenses directly by clicking the "Purchase" / "Add Licenses" button.

Clicking the Administrator's Name on the top-right allows the ability to edit the Profile (Name, Email address, and Password) or Log out of the Control Center.

Below, see a read-only glance at Job Runs statistics, including Errors From the Most Recent Run Of Jobs per Job Runner and Long Time No Job Runs.

A more detailed view of this information can be found under Reports.

Back to the Top

Getting Started

The "Getting Started" section offers a concise introduction to the Control Center, outlines its features, and provides instructions on initiating your experience with the Control Center.

Click the "Start an Interactive Tour" button to start a tour that will provide step-by-step guidance.

Back to the Top

Job Runners

A Runner consists of a particular User on a specific Computer. To be eligible to receive Jobs, each Runner must receive authorization from an Administrator.

The total count of Computers with established GoodSync service, combined with the total number of Users on those Computers, determines the overall requirement for GoodSync Runners in the system.

The Control Center will automatically incorporate Runners into its system as they are configured.

NOTE: For more details on setting up a Runner to receive Jobs from the Control Center, please see the Runner Deployment chapter.

To start with this section, a List of all existing Runners will be displayed:

The List can be sorted by Runner Name, number of Runner Groups or Jobs assigned to the Runner, and Runner version by clicking the corresponding column header.

To find the necessary Runners within the List, click the "Filter" button. Filter by Runner Name, Runner Type (Workstation or Server), Runner version, and Authorization status (All/Authorized only/Disallowed only).

Back to the Top

Authorizing Runners

Authorizing or Deauthorizing (Disallowing) a Runner means setting whether this Runner will or will not receive and run assigned Jobs.

Authorizing Runners in bulk using the "Actions" button within the Runner List or from the Runner details using the "Authorize/Disallow" button, as described below.

Back to the Top

Runner Details

From the Runner List, click on the Name of a Runner. That will bring up the Runner details screen. Here, discover the tools for managing and tracking Runners.

On the top right, the "Authorize/Disallow" and "Delete" buttons allow performing the corresponding actions.

NOTE: Deleting a Runner will delete it from the Control Center but not from the Computer it is installed on.

Below the buttons, a panel with information (Authorization status, User and Computer names, Runner Type, and version) about the Runner is shown.

Further down, two panels display the Runner Groups this Runner is in and the Jobs assigned to it, if any.

The next panel, "Job Runs in Progress," displays a list of active Job Runs by this Runner (if any), their status, and progress. The list can be sorted by clicking the column header that serves as the sorting criteria.

At the bottom, in the "Job Runs History" panel, the history of Job Runs by this Runner is available. Click the magnifier icon in the "Log" column to view the detailed Job Run Log. Or click the Job Name to proceed to the Job details.

Back to the Top

Adding Runners to Groups

Runner Groups allow assigning a group of Runners to a Job or multiple Jobs. These entities are described below in this Manual.

1. To add or remove the Runner from the Groups, click the "Edit List" button on the "Runner Groups" panel.
2. A window will appear, showing a list of available Runner Groups and allowing to add or remove the Runner to/from them by checking or unchecking the corresponding boxes on the right. When done, click "Save" to apply the changes.

Back to the Top

Assigning Runners to Jobs

To get a Job run, assign a Runner to it. For that:

1. Click the "Edit List" button on the "Runner Jobs" panel.
2. This presents a list of all Jobs in the Control Center. Check the Jobs to assign to the Runner using the boxes on the right and click "Save" to apply the changes.

Back to the Top

Runner Bulk Actions

To Authorize or Deauthorize Runners in bulk, check the checkboxes on the right corresponding to the desired Runners, click the "Actions" button, and select "Authorize" or "Disallow," then click "Save."

Runners can be deleted from the Control Center by checking them and choosing "Delete" from the "Actions" menu.

Back to the Top

Runner Groups

This section allows the management of Groups of Runners. Administrators may create Groups and assign them to Jobs.

To start with this section, a list of all existing Runner Groups is presented:

Groups can be filtered using the "Filter" field and the Group status drop-down. By default, only active Groups are shown. To view all or only deactivated Groups, click the drop-down (defaulted to "Show only active") and select "Show All/Show only inactive."

Back to the Top

Creating Groups

1. To create a new Runner Group, click the green "Create New Job Runner Group" button.
   
   
   
2. A window will appear, prompting to specify the Group Name. Input the Name into the field and click "Save."
   
   
   
3. After creating a Group, go to the Group Details screen to add Runners and assign Jobs. Click the Runner Group Name in the List for that.

Back to the Top

Group Details

This screen provides access to the tools for managing and tracking Runner Groups.

On the top right, the "Rename Group" and "Activate/Deactivate" buttons allow performing the corresponding actions.

Deactivating a Group will prevent the Jobs it is assigned from running by the Runners in the Group.

The left panel displays the Runners in the Group and allows editing of them. The right panel reflects the Jobs assigned to the Group and allows editing of them.

The next panel, "Job Runs in Progress," shows a list of active Job Runs by this Group, their status, and progress. Sort the list by clicking the column header to the desired to by sorting criteria.

At the bottom, on the "Job Runs History" panel, find the history of Job Runs by the Runners in this Group. Clicking the magnifier icon in the "Log" column will open the detailed Job Run Log. Clicking the Job Name on this panel will bring up the Job details. Clicking the Runner's Name will bring up its details.

Back to the Top

Adding Runners to Group

1. To manage Runners in the Group, click the "Edit List" button on the "Runners in Group" panel.
   
2. A window will appear, showing a list of all available Runners and allowing to add or remove them to/from the Group by checking or unchecking the corresponding boxes on the right. When done, click "Save" to apply the changes.
   
   
   

Back to the Top

Assigning Groups to Jobs

1. To assign the Group a Job or multiple Jobs, click the "Edit List" button on the "Jobs Assigned to Group" panel.
   
2. Check the Jobs to be assigned using the boxes on the right and click "Save" to apply the changes.
   
   
   

Back to the Top

Group Bulk Actions

The "Actions" button in the Group List allows to Activate/Deactivate or Delete the Groups in bulk. Select the desired Runner Groups from the List by checking their boxes on the right, click "Actions," and select the appropriate action.

Back to the Top

Jobs

A Job is a fundamental unit of work in GoodSync that represents a synchronization or backup task. Each Job consists of a unique Job Name, optional Description, Left and Right Folders, and a wealth of fully configurable Job Options. The Job Options can be set to configure Versioning, Automatic Scheduling, Alerting, Scripting, and more.

A Job in the Control Center has all the same options as a Job created through the GoodSync GUI, except all Jobs assigned by the Control Center are run without a User Interface by default.

Learn more about GoodSync Jobs from the GoodSync Manual.

In this section, Jobs can be fully managed through the Control Center. Administrators may add/remove and edit all Job Options as well as assign Runners and Runner Groups to Jobs.

To start with the section, a List of all existing Jobs will be shown:

The Jobs can be filtered using the "Filter" field and the Jobs status drop-down. By default, only active Jobs are shown. To view all or only deactivated Jobs, click "Show only active" and select "Show All/Show only inactive."

Back to the Top

Creating Jobs

1. Click the "Create New Job" button in the Job List.
   
   
   
2. The Job creation interface will be opened.
   Choose a Template for the new Job. Use the left/right arrows to browse through the available Templates.
   If manual configuration of all settings is preferred, click "Create Your Own."
   
   
   
3. Next, a Job editing dialog that reflects all Job Options will be shown.
   
   
   
4. Enter the Job Name and, optionally, the Job Description.
5. Set up the Left and Right Folders for the Job. The File System and Path can be specified manually, or a Server Account can be used.
   A Server Account contains the address and credentials for a remote Server (like FTP, WebDAV, or cloud storage) stored in an encrypted format. Server Accounts may be configured in the GoodSync GUI application and uploaded to the Control Center.
   NOTE: All Server Accounts available in the Control Center are displayed in the Server Accounts section.
6. Next, on the "General" tab, set the Direction for the Job and other preferred Options such as Auto, Filters, and Scripts on their corresponding tabs.
   NOTE: For detailed information about the GoodSync Job Options, please refer to the GoodSync Manual, which will lead through all the available options.
7. When done, click the "Save" button to save the Job. Once the Job is created and saved, the Job Details screen will be shown.
   NOTE: Jobs can be created not only via the Control Center but also by uploading local GoodSync GUI Jobs to it. Learn more from the Uploading Jobs to the Control Center chapter.

Back to the Top

Job Details

On this screen, one can find the Job management and tracking tools.

At the top right, a group of buttons is visible:
• Edit Job. Open the Job editing dialog that allows changing the Job Options described above in the Creating Jobs chapter.
• Clone Job. Clone this Job and open the details of the cloned Job.
• Special Ops. Show the Special Operations window that provides options for performing some exotic Job actions (described below).
• Run Job. Run the Job manually on all Runners that this Job is assigned to.

Clicking the "Job Command Line" link will display a command that can be used to run this Job via a GoodSync command-line interface, for instance, via GSYNC.

Below the buttons, two panels reflecting the Left and Right Folders of the Job are displayed.

Further below, the "Options" panel shows the Options set for the Job.

Below the Options, there are two panels. The left panel displays the Runners Groups this Job is assigned to and allows editing of them. The right panel reflects the Runners this Job is assigned to and allows editing of them.

The next panel, "Job Runs in Progress," shows a list of active Runs of this Job, their status, and progress. The list can be sorted by clicking on the column header that corresponds to a preferred sorting criteria.

At the bottom, in the "Job Runs History" panel, the history of the Job Runs can be viewed. Clicking the magnifier icon in the "Log" column will open the detailed Job Run Log. Clicking the Job Runner Name will bring its details.

Back to the Top

Assigning Jobs to Runner Groups

1. To assign the Job to a Group, click the "Edit List" button on the "Runner Groups" panel.
2. A window will appear, showing a list of all available Groups and allowing to assign or unassign them to the Job by checking or unchecking the corresponding boxes on the right. When done, click "Save" to apply the changes.
   
   
   

Back to the Top

Assigning Jobs to Runners

1. To assign Jobs to the Group, click the "Edit List" button on the "Jobs Assigned to Group" panel.
2. This will display a list of all Runners in the Control Center. Check the boxes on the right that correspond to the Runners to which the Job should be assigned, and then click "Save" to apply the changes.
   
   
   

Back to the Top

Running Jobs

If the Auto (scheduling) options are configured for the Job, it will run automatically on the Runners after the assignment. If not, the Auto options can be configured by clicking the "Edit Job" button on the top right of the Job details screen and switching to the "Auto" tab.

To run the Job manually, click the "Run Job" button on the top right of the Job details screen.

Here is an example of a Job Run by a Runner installed on Windows:

Back to the Top

Job Bulk Actions

The "Actions" button in the Job List allows deleting, deactivating Jobs, or swapping their Left and Right Folders in bulk. Select the desired Jobs from the List by checking their boxes on the right, click "Actions," and click the appropriate menu item.

Deactivating a Job will prevent it from running by any Runners.

The "Update Backup Left to Right" and "Update Backup Right to Left" options allow swapping the Left and Right Folders for the backup Jobs.

Back to the Top

Job Special Operations

Special Operations can be performed for Jobs to accomplish several exotic actions. These are primarily used for error resolution and/or cleanup.

A window will appear, allowing the selection of the Special Operation to perform, as well as the Runners to issue the operation to.

The following options are available for Special Operation:
• Delete State Files. Delete GoodSync state files on both sides of this Job. If the state file becomes corrupted, this Special Operation may be used to clear the Job Run.
• Delete Recycled. Delete the recycled files located in the folder "_gsdata_\_saved_" and history files located in the folder "_gsdata_\_history_."
• Cleanup Recycled. Clean up the "_saved_" and/or "_history_" folders: delete any files that are older than the prescribed time (one month by default).
• Delete GS Data. Delete the GoodSync "_gsdata_" folder and all files contained in it on either side or both. Removes everything removed by "Delete Recycled" and "Delete State Files," plus all Job Log files.

Back to the Top

Uploading Jobs to the Control Center

Uploading local GoodSync Jobs enables the running and management of these Jobs within the Control Center.

Follow these steps to upload the Jobs to the Control Center (a Windows machine is used in this example):
1. First, ensure the current device is connected to the Control Center as a Runner.
2. Next, open the GoodSync GUI. On Windows, the GoodSync GUI application can be found in the "C:\Program Files\Siber Systems\GoodSync\GoodSync.exe" folder. On Mac, GoodSync.app can be located in the "Applications" folder.
3. Before uploading the Jobs, upload Server Accounts to the Control Center.
4. Check that both the Left and Right Folders have been set for Job(s).
5. Use the "Tools" >> "Advanced" >> "Upload Jobs to Control Center" menu item ("GoodSync" >> "Upload Jobs to Control Center" on Mac).
6. If all steps are followed correctly, GoodSync will display a notification confirming that the Accounts have been successfully uploaded to the Control Center.
   
   
   

Back to the Top

Server Accounts

A Server Account contains the address and credentials used in the GoodSync GUI application to access any supported File System (e.g., an FTP server or a cloud storage). These Accounts can be uploaded to the Control Center so that these may be used in the Jobs.

To start, a read-only List of all Accounts uploaded to the Control Center will be shown.

Click "+" on the left of an Account to see a list of Folders used by Jobs from this Account.

Clicking the "Clear All" button will remove all uploaded Server Accounts from the Control Center.

Back to the Top

Uploading Accounts to the Control Center

Uploading Server Accounts to the Control Center allows the selection of these locations within the Control Center Jobs.

That is how to upload the Accounts from the GoodSync GUI application (a Windows machine is used in this example):
1. First, ensure the current device is connected to the Control Center as a Runner.
2. Next, open the GoodSync GUI. On Windows, the GoodSync GUI application can be found in the "C:\Program Files\Siber Systems\GoodSync\GoodSync.exe" folder. On Mac, GoodSync.app can be located in the "Applications" folder.
3. Navigate to "Tools" >> "Program Options" >> "Account" (or "GoodSync" >> "Preferences" >> "Account" on Mac). In the "Control Center Upload" section, specify the Email and Password of the Company Administrator account.
   The "Server Accounts Encryption Password" field may be left empty.
   NOTE: If a "Server Accounts Encryption Password" was specified, use the /cc-acct-pwd flag during the installation of a Control Center Runner to allow the decryption of the encrypted Accounts and Jobs.
   
   
   
4. Click "Save" to apply the changes.
5. Use the "Tools" >> "Advanced" >> "Upload Accounts to Control Center" menu item ("GoodSync" >> "Upload Accounts to Control Center" on Mac).
   
   
   
6. If all steps are followed correctly, GoodSync will display a notification confirming that the Accounts have been successfully uploaded to the Control Center.
   
   
   

Back to the Top

Using Accounts in Jobs

Now that Server Accounts have been uploaded to the Control Center, these can be referenced in Jobs.
1. When creating new Jobs or editing the existing ones, navigate to the "Left Folder/Right Folder" tab and turn on the "Use Server Accounts" switch. All available uploaded Accounts will be listed via a drop-down.
   
   
   
2. Select an Account first, then select a Folder within that Account.
3. When done, click "Save" to apply the changes.
   NOTE: One Server Account may be used by multiple Jobs.

Back to the Top

Job Runs

A Job Run corresponds to an individual GoodSync Job doing an instance of a backup or synchronization from a Runner.

That is the basic level of Job Reporting, as all other Job Reports are derivatives of this information.

That is a more complete version of the Job Runs information seen on other screens (Runner details, Group details, Job details, etc.), as those are a subset of this for that specific item (the individual Runner, Group, Job, etc.).

To start, a List of all completed and currently running Jobs will be presented.

The "Job Runs In Progress" panel displays all currently running Jobs (if any), their status, and progress. The list can be sorted by clicking the column header that serves as the sorting criteria.

A Job Run can be stopped by clicking the "Stop" button on the second column. Possibly stalled Jobs Runs can be cleared by clicking on the "Clear Stalled" button in the header of this column.

By default, the history of all Job Runs appears on the "History of Job Runs" panel. Filters are available to refine the list of Job Runs, including time range, Job Name, Job Runner, Status, and Result. To do so, click the "Filter" button, configure the desired filters, and select "Apply Filter."

Back to the Top

Reports

The Control Center Reports show compiled GoodSync Job information on specific Backups and Synchronizations for all Runners.

Here are the available Types of Reports:
• All Recent Errors. Errors during the most recent Run of a Job for a Runner.
• Long Time No Job Runs. List of Runners that have Job(s) assigned to them, where the Job has not Run for a long time.
• Last Job Runs. List of the most recent Runs of each Job for each Runner.
• Last Successful Run. List of the most recent successful Runs of each Job for each Runner. This is similar to Last Job Runs, but only if the Result is OK and there were no errors or conflicts.
• Data Transfer Usage. The maximum, minimum, and average data transferred by each Runner/Job.
• Changes Log. History of changes in Jobs, Runners, Administrators, Settings, etc.

Click "Build Report" located to the right of the chosen Report Type, and the Report screen will be opened once it's prepared. Rearrange the entries in the list by selecting the column headers that serve as sorting criteria.

Back to the Top

Administrators

The Administrators section allows the management of Company Administrators.

Company Administrators have full control over all aspects of the Control Center.

Initially, a List containing all Company Administrators is shown.

Administrators can be filtered using the "Filter" field and the drop-down for Administrator status. By default, only active Administrators are shown. To view all or only deactivated Administrators, click "Show only active" and select "Show All/Show only inactive."

Back to the Top

Creating Administrators

1. To create a new Company Administrator, click the green "Create New Administrator" button.
   
   
   
2. A window will appear, prompting to specify the Administrator Name, Email address, Temporary Password, and confirmation. Input these into the corresponding fields and click "Save."
   
   
   
3. The new Company Administrator will then be added to the Administrators List. Click "Send Confirmation Email" to confirm the email address for the new Administrator. The confirmation email will be sent to the Email address provided.

Back to the Top

Administrator Bulk Actions

The "Actions" button in the Administrators List allows to Delete or Activate/Deactivate the Company Administrators in bulk. Select the desired Administrator accounts from the List by checking their boxes on the right, click "Actions," and select the appropriate action.

Back to the Top

Settings

The Control Center Settings allow affecting how the Control Center behaves and setting Global Program Options for the Runners connecting to the Control Center.

Let's review each panel in this section:

Back to the Top

Company Settings

These reflect the Company's general and security settings. Click "Edit Company Settings" to edit them.

• Company ID. The Company ID denotes the specific instance of the Control Center. It tells the Runners which Company on the Control Center they should be receiving Jobs from. The Company ID is set when creating the Company and cannot be changed.
• Allow Administrator Login Only With Confirmed Email. If checked, only allow Administrators with a confirmed Email address to log in.
• Auto Log Out after Idle. Configure the auto logout time in hours.
• Require PIN code on Runner registration. A Company PIN can be set to act as a white list for newly installed runners. If a Company PIN is set, and an installed runner does not use the "/cc-copin" flag with the correct PIN during installation, it will not connect to the Control Center.
• Use Two-Factor Authentication. Turn on or off the One Time Password authentication (2FA).
  NOTE: To use One Time Password authentication, all company Administrators must complete the email confirmation process.

Back to the Top

Personal Settings

These are the personal settings of the currently logged-in Administrator. Click "Edit Personal Settings" to edit them.

• Choose Language. Sets the display language for the Control Center UI.
• Dashboard. Show Jobs that have not Run in. If a scheduled Job does not Run in this many days for any reason, create a notification in the Dashboard under "Long Time No Runs."
• Choose Locale Format. Configure the Date/Time formatting for the Job Run display.
• Choose Timezone. Specify timezone settings for the Job Run display.
• Receive Stopped Runners Email. System checks for offline runners occur daily at 12 PM UTC. During these checks, the Control Center confirms the last activity of a Runner and subtracts it from the current time. If the runner has been offline for an amount of time equal to or greater than the notification period, an email alert will be sent to the Administrator.

Back to the Top

Global Runner Options

The settings on this panel allow configuring the global settings relating to the Update Management, Auto Job Runs, Logs and History, Global Job Filters, Proxy settings, and SMTP settings for alerting.

These are equal to the settings found under "Tools" >> "Program Options" ("GoodSync" >> "Preferences" on Mac) in GoodSync GUI. An overview and description of these settings are available in the GoodSync Manual.

Back to the Top

License Information

Displays details concerning the current licenses. Click "Buy More" to get additional Runners for the Control Center.

Back to the Top

Company Administrators Sessions

This panel shows the current Administrator sessions. A session may also be revoked for an Administrator anytime by clicking the "x" icon by the desired Administrator session.

Back to the Top

Company Administrators Sessions History

A record of all Administrator sessions is logged for reference and auditing purposes. This record contains information including the Administrator's Name, IP address, browser type, operating system, and the last access time.

Back to the Top

Runner Deployment

This guide will show how to deploy Windows, Mac, and Linux/NAS Runners that perform backups and syncs on command from the Control Center Server.

The Runners connect to the Control Center, receive Jobs, execute these Jobs, and report results to the Control Center.

Back to the Top

Getting Company ID

Before deploying Runners to Client computers on any supported platform, it's essential to find the Company ID. This will enable the Runner installer to connect to a specific Control Center instance.

The Company ID is consistently indicated alongside the Company Name in the top bar.

Alternatively, the Company ID can be found within the Company Settings:

1. Log in to the Control Center.
2. Navigate to the "Settings" section.
3. On the "Company Settings" panel, locate the Company ID and copy it if needed.
   
   
   

Back to the Top

Deploying Runners on Windows

1. Download the GoodSync CC Runner installer for Windows.
2. Open a Command Prompt window and navigate to the folder that the installer has been downloaded. By default, this will typically be in the Downloads folder of the current User (C:\Users\Username\Downloads). The "cd" command can be used to move through the directory structure, and the "dir" command can be used to view the contents of the current location.
3. Run the installer with the appropriate options. There are two approaches to user setup:
   
   • User space: The runner will run only while the user is logged on. This can be used for easy mass deployment, as it will not require the Windows user account password.
     
     If using the Control Center at jobs.goodsync.com, use the following command for user-space setup:
     GoodSync-vsub-CC-Runner-Setup.exe /cc-runner=user /cc-coid=companyID /S
     
     If using a self-hosted Control Center, add the "/cc-url" flag to point to the IP of the self-hosted environment for user-space setup:
     GoodSync-vsub-CC-Runner-Setup.exe /cc-runner=user /cc-coid=companyID /cc-url=http://ip-address /S
     
     
     
   • Service: The runner will run even if the user is logged off. This cannot be used for mass deployment, as it will require the Windows user account credentials that should be specified using the "/sys-userid" and "/sys-passwd" options.
     
     If using the Control Center at jobs.goodsync.com, use the following command for service setup:
     GoodSync-vsub-CC-Runner-Setup.exe /cc-runner=service /cc-coid=companyID /sys-userid=username /sys-passwd=userpassword /S
     
     If using a self-hosted Control Center, add the "/cc-url" flag to point to the IP of the self-hosted environment for service setup:
     GoodSync-vsub-CC-Runner-Setup.exe /cc-runner=service /cc-coid=companyID /sys-userid=username /sys-passwd=userpassword /cc-url=http://ip-address /S
     
     
     
4. Once setup is complete, navigate to the "Job Runners" section in the Control Center. There, the installed Runner will appear within the Runner List.
5. From the List, check the box on the right corresponding to the newly installed Runner, click "Actions" and select "Authorize" to Authorize Runner, so it can get the assigned Jobs.
   
   
   

Back to the Top

Installer Parameters and Options

/cc-runner=user|service
The "user" value specifies the intention to install a Control Center Runner in the user space.
NOTE: The "user" value is not to be replaced with an actual username.

The "service" value specifies the intention to install a service Control Center Runner.

/cc-coid=companyID
Sets the Company ID found in the Settings section on the Control Center UI.

/mini-progress=yes|no
Show (or not) a Mini Progress popup that shows the status and progress of a Job Run.

/user-close=yes|no
Allow the user (or not) to close the Runner via its Taskbar icon or Mini Progress popup.

/sys-userid=username
The username of a Windows User, under which the Runner service will run.

/sys-passwd=userpassword
The password of the Windows User, under which the Runner service will run.

/cc-url=serverURL
Sets the URL of a self-hosted Control Center Server instance from which this Runner gets Jobs. The default is https://jobs.goodsync.com

/cc-copin=companyPIN
If a Company PIN is set in the Settings section of the Control Center, runners must provide the correct PIN to connect with it.

/cc-acct-pwd=password
Sets the Server Account encryption password. Used by the Runner to decrypt Server Accounts.

/cc-allow-bad-certs
Allow the Runner to talk to the Control Center Server that shows a self-signed certificate (TLS/SSL).

/cc-proxy=host:port
Proxy Host and Port, used to connect to Control Center Server.

/cc-proxy-auth=user:password
Proxy Auth, used to connect to the Control Center Server.

/S
Run the installer in silent mode without any GUI. That allows it to function as an MSI for silent installation and mass deployment.

Back to the Top

Runner Mass Deployment

For mass deployment to all or a batch of computers, the same user-space setup command, using the "/cc-runner=user" flag, may be used for all devices (and pushed via GPO, scheduled task, etc.).

After the initial install, the Runner will create its startup task, so this command only needs to run once for all devices.

Mass deployment through SCCM

Please refer to the Deployment Guide through SCCM.

Mass deployment through GPO

Please refer to the Deployment Guide through GPO.

Back to the Top

Deploying Runners on Mac

1. Download the GoodSync CC Runner installer for Mac.
2. Open a Terminal window and navigate to the folder that the installer has been downloaded. By default, this will typically be in the Downloads folder of the current User (/Users/Username/Downloads). The "cd" command can be used to move through the directory structure, and the "ls" command can be used to view the contents of the current location.
3. Grant the installer execution permissions with the following command:
   chmod +x goodsync-vsub-cc-runner-mac.sh
   
   If the command is successful, there will be no result or message shown.
   
   
   
4. Run the installer with the appropriate options. There are two approaches to user setup:
   
   • User space: The runner will run only while the user is logged on.
     
     If using the Control Center at jobs.goodsync.com, use the following command for user-space setup:
     ./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=companyID
     
     If using a self-hosted Control Center, add the "/cc-url" flag to point to the IP of the self-hosted environment for user-space setup:
     ./goodsync-vsub-cc-runner-mac.sh /cc-runner=user /cc-coid=companyID /cc-url=http://ip-address
     
     
     
   • Service: The runner will run even if the user is logged off. This cannot be used for mass deployment, as it will require the Windows user account credentials that should be specified using the "/sys-userid" and "/sys-passwd" options.
     
     If using the Control Center at jobs.goodsync.com, use the following command for service setup:
     ./goodsync-vsub-cc-runner-mac.sh /cc-runner=service /cc-coid=companyID /sys-userid=username
     
     If using a self-hosted Control Center, add the "/cc-url" flag to point to the IP of the self-hosted environment for service setup:
     ./goodsync-vsub-cc-runner-mac.sh /cc-runner=service /cc-coid=companyID /sys-userid=username /cc-url=http://ip-address
     
     
     
5. Once setup is complete, navigate to the "Job Runners" section in the Control Center. There, the installed Runner will appear within the Runner List.
6. From the List, check the box on the right corresponding to the newly installed Runner, click "Actions," and select "Authorize" to Authorize Runner so it can get the assigned Jobs.
   
   
   

Back to the Top

Installer Parameters and Options

/cc-runner=user|service
The "user" value specifies the intention to install a user space Control Center Runner.
NOTE: The "user" value is not to be replaced with an actual username.

The "service" value specifies the intention to install a service Control Center Runner.

/cc-coid=companyID
Sets the Company ID found in the Settings section on the Control Center UI.

/sys-userid=username
The username of a macOS User under which the Runner service will run.

/cc-url=serverURL
Sets the URL of a self-hosted Control Center Server instance from which this Runner gets Jobs. The default is https://jobs.goodsync.com

/cc-copin=companyPIN
If a Company PIN is set in the Settings section of the Control Center, runners must provide the correct PIN to connect with it.

/cc-acct-pwd=password
Sets the Server Account encryption password. Used by the Runner to decrypt Server Accounts.

/cc-allow-bad-certs
Allow the Runner to talk to the Control Center Server that shows a self-signed certificate (TLS/SSL).

/cc-proxy=host:port
Proxy Host and Port. Used to connect to Control Center Server.

/cc-proxy-auth=user:password
Proxy Auth. Used to connect to the Control Center Server.

Back to the Top

Deploying Runners on Linux/NAS

1. Download the GoodSync CC Runner installer for Linux from
   https://www.goodsync.com/download/cc-runner-install-x86_64-release.run
2. Grant the downloaded installer execution permissions with the following command:
   chmod +x cc-runner-install-x86_64-release.run
   
   If the command is successful, there will be no result or message shown.
   
   
   
3. Run the installer:
   ./cc-runner-install-x86_64-release.run
   
   
   The Runner installer will prompt the user for the following information:
   
   Binary installation directory – path to the directory that the Runner will be installed. If no input is provided, the default path "/usr/bin/gs-cc-runner" will be used.
   
   System user – Linux user account on behalf of which the Runner will be running.
   
   Job server URL – Control Center URL. If no input is provided, the default URL "https://jobs.goodsync.com" will be used.
   NOTE: If using a self-hosted Control Center, enter the IP of the self-hosted server.
   
   Company ID – points the Runner to a particular Control Center instance.
   
   Company PIN – PIN used to whitelist incoming runners (optional).
   
   Encryption password – Server Account encryption password (optional). Used by the Runner to decrypt Server Accounts.
   
   The installer will create a cron job to run the Runner instance on the system start automatically.
   
   
   
4. Once setup is complete, navigate to the "Job Runners" section in the Control Center. There, the installed Runner will appear within the Runner List.
5. From the List, check the box on the right corresponding to the newly installed Runner, click "Actions," and select "Authorize" to Authorize Runner so it can get the assigned Jobs.
   
   
   

Back to the Top

Deploying Runners on Android

For connecting an Android device to the Control Center, consider employing the GoodSync CC Runner app designed for Android.

1. In Google Play, search for "GoodSync Runner" and click the "CC Runner" item in the search results.
2. Once on the app page, click "Install."
   
   
   
3. After installation is complete, click "Open."
   
   
   
4. Enter the following information to connect the Runner to the Control Center:
   
   Company ID – points the Runner to a particular Control Center instance.
   
   Company PIN – a PIN used to white-list incoming runners (optional).
   
   Server Address – Control Center URL. If no input is provided, the default URL "https://jobs.goodsync.com" will be used.
   NOTE: If using a self-hosted Control Center, enter the IP of the self-hosted server.
   
   User Name – the Runner will be identified by the provided user-name@device-id in the Control Center.
   
   Accounts Encryption Password – Server Account encryption password (optional). Used by the Runner to decrypt Server Accounts.
   
   Allow bad certificates – allow the Runner to talk to the Control Center Server that shows a self-signed certificate (TLS/SSL).
   
   Start runner on device boot – ensure the Runner app begins on the device boot. Click "Done" after the appropriate information is provided.
   
   
   
5. Once the Runner setup is complete, click "Start" to start it.
6. Next, navigate to the "Job Runners" section in the Control Center. There, the installed Runner will appear within the Runner List.
7. From the List, check the box on the right corresponding to the newly installed Runner, click "Actions," and select "Authorize" to Authorize Runner so it can get the assigned Jobs.
   
   
   

Back to the Top