Help Documentation

Safeguard Documentation

Download Symbient Safeguard

To get started with Symbient Safeguard, you will need to download the latest version from Symbient Uptime.

1. Log in to your Symbient Uptime account.
2. Click on the Settings icon on the bottom-left toolbar, or click here.
3. Click on the "Downloads" tab within the Settings panel to view all downloads.
4. Locate the latest version of Symbient Safeguard. It will have a "Latest" badge next to it.
   • (Optional) Use the "Filter by Product" dropdown to select Safeguard and narrow the list.
5. Click on the file listed under Assets to download the .zip package.
6. Extract this .zip file to the folder of your choice.

Configuring Symbient Safeguard

Most users can skip this section unless instructed by your IT team or if your Safeguard installation was not preconfigured.

To allow Safeguard to send data to your group's Symbient Uptime account, you will need to configure the settings.json file within your Safeguard folder.

Steps to Configure

1. Open the folder where you extracted Symbient Safeguard.
2. Locate the file named settings.json.
3. Open settings.json in a text editor such as Notepad.
   • Scroll to the bottom of the file. You’ll see a section that includes the following fields:
     1. Groupid – This is your Uptime group identifier.
     2. ApiKey – Your group's API access key.
     3. EncKey – The encryption key used for secure communication.
4. To get the Groupid, ApiKey, and EncKey for your group, go to Symbient Uptime.
5. Log in to your Symbient Uptime account.
6. Click on the Settings icon on the bottom-left toolbar, or click here.
7. On the Settings tabs, click on Integrations
   • You should then see a page displaying your Groupid, ApiKey, and EncKey.
8. Enter these values into the corresponding fields in settings.json.
   • The fields should look like this:
     1. "Groupid": "12345-12345",
     2. "ApiKey": "123ABC",
     3. "EncKey": "pk_abc"
9. Save and close the file.

Once configured, Symbient Safeguard will be able to communicate with your group’s Uptime account and begin sending data once the application is registered and running.

About settings.json

The settings.json file contains all the configuration and license data Symbient Safeguard uses to operate. This includes:

• License keys
• Uptime integration settings
• Alert configuration and scan behavior

Important: During upgrades, only the executable and dependency files should be replaced. The settings.json file remains untouched unless your IT team specifically overwrites it during deployment.

Symbient Safeguard is designed to automatically recognize and preserve existing settings. When a new version is launched, it will merge in any new required settings while keeping your current configuration intact. This ensures a smooth upgrade process without loss of configuration.

Registering Symbient Safeguard

Once Symbient Safeguard has been downloaded and extracted, you will need to register the product.

Note: If your company's IT team has already registered Safeguard on your machine, you can skip this step.

To Register

1. Launch the Safeguard application by double-clicking Safeguard.exe in the extracted folder.
2. Navigate to the Settings tab within the application.
3. In the License section, you will see two fields:
   1. System Key (auto-generated)
   2. License Key (this will be blank initially)
4. Copy the System Key and send it to our support team at support@symbient.online.
5. Our team will generate a License Key that will be tied to your system and email it back to you.

To Complete Registration

1. Once you receive the License Key:
   • Return to the License section in Safeguard.
   • Click the Update button.
   • Paste the key we sent you into the field labeled "Paste license key here."
   • Click Register.
2. After successful registration:
   • The License Key field will populate with the validated key.

Symbient Safeguard will begin monitoring and sending alerts to the Uptime dashboard. These alerts should also show up on your desktop as system alerts.

Upgrading Symbient Safeguard

When a new version of Symbient Safeguard is released, updating is straightforward and does not require re-registering the application or manually backing up configuration files in most cases.

Upgrade Process

1. Download the latest version of Symbient Safeguard from the Uptime Settings > Downloads page, see Download Symbient Safeguard for detailed instructions.
2. Replace the existing Safeguard.exe and related files with the updated ones from the .zip package.
   1. Do not delete your existing folder unless instructed by support.
   2. Do not replace your settings.json file.
   3. The settings.json file will remain intact unless your IT department explicitly overwrites it.
3. Launch the updated Safeguard.exe.

If your upgrade was pushed by IT and your settings appear to be missing, please check if the settings.json file was replaced. If so, you may need to restore it from a backup or re-enter your license key.

Expired Licenses

Symbient Safeguard requires a valid license key to continue monitoring and sending alerts. Here's how license expiration works:

Understanding License Expiration

• License keys are tied to each device and generated to expire on a specified date.
• If the license has expired, Safeguard will stop scanning and reporting.

Renewing Licenses

Licenses can be renewed by contacting Uptime Support:

1. When licenses need to be renewed, Uptime Support can provide you with an updated license key.
2. You will need to provide Support with the current System Keys from each device you want to renew the license for.
3. Support will then generate and send you new License Keys for each of your devices.
4. You will then update the License Key in Safeguard:
   • Open Safeguard
   • Go to Settings > License
   • Click Update
   • Paste the new License Key
   • Click Register

Symbient Safeguard will validate the updated key and resume normal operations.