SkySync Installation Guide

Owned by Peter Ransom (Deactivated)
Last updated: Dec 03, 2018
9 min read

SkySync creates its database using SQL software. The versions and their uses are explained briefly below and a more in depth explanation can be found in our Best Practices article. It is advised to read the best practices article prior to installing as it contains the hardware and OS requirements for properly using SkySync. This will allow you to ensure that you have optimized your computer and database infrastructure to best suit your needs. 


If you are intending to utilize metadata imports it is advised that servers having SkySync installed on it be set to UTC time. This is because SkySync uses the timezone the SkySync server is set to as the 'starting' timezone, then converts to UTC, which can result in time stamps being shifted to the next day.


It is important to note that the Operating System SkySync is installed needs to be set to a US English Local

SQL CE 

SQL Compact Edition or CE is the default database used when utilizing the standard installation, which is the simplest SkySync installation possible. SQL CE and the standard installation are best used for smaller customers as there are some inherent limitations. SQL CE can only have up to 3 million folder and file objects and is limited to a 4GB database size. Additionally it is more difficult to move a SQL CE database to a new server, where as SQL express and Full SQL are much more portable. Additionally the use of SQL CE will also limit SkySync to running no more then 2 jobs simultaneously. 


SQL Express, Full SQL and SQL Enterprise

SQL Express, Full SQL and SQL Enterprise allow for 6 jobs to run simultaneously and is required for larger installations. The major difference between the first 2 is that SQL Express has a maximum database size of 10GB where as full SQL had a max size of 524PB (petabyte). Additionally Full SQL is capable of using multiple computers to create its database. In order to use SQL or SQL Express is must be first installed and setup on the server containing it. Additionally a "SkySync" database will need to be created and it is advised that a user specific to SkySync be created with ownership rights to the Database as well. The user, database name, and user password will all be required during the install. SQL Enterprise is best used for massively large scale implementations of SkySync as it provides additional tools and capabilities that the other options do not. Examples of this are automated reports of the file migrations. 


Typical Installation

The Steps illustrated below assume that all other Hardware and OS configurations have been completed. Completing the below process will utilize SQL CE, and use the windows account currently being utilized by the user. Ensure that you have your License Key available, and it is a best practice to utilize a windows user/account specific to SkySync.

1) Download the most current version of SkySync from the link provided by your Service Representative. This link will be sent to the contact associated with the purchased license and if you are not the contact you will need to get the link from them or contact services or support to obtain a link.

2) Unzip the folder and open the SkySync application file (depending on the security settings of the computer you may need to run the file as administrator) 

3) When the Installer pops up read the License Agreement before checking the box accepting the terms. 

4) Ensure that Typical installation is selected and then click Install

5) Once the installation is complete a screen should appear announcing this. Check the box "Launch application on exit" before clicking "Exit" to immediately launch and begin using SkySync

Note: that the database configuration is SQL Server CE and the location of the program folders are automatically selected with a typical installation. Additionally the user used by the SkySync service will always be integrated authentication by default. If a different Windows User is desired for the SkySync Service then custom install will have to be selected. This is illustrated in the steps for Custom Install below, and the steps involving SQL can be skipped and just maintaining the SQL CE selection.

6) You will be prompted to enter your license key when first launching SkySync


Windows Defender Warning

It is possible when installing SkySync, that you will receive a message from Windows Defender blocking the install. This message can be manually bypassed by expanding the More Info.

 Expand for more information and image

This is not a cause for alarm and should stop happening in the near future. Some of our newer features resulted in the security system identifying us as a potential threat in their latest versions. Unfortunately we do not have a time frame for when the warning will stop occurring, but as mentioned it should not be the cause for alarm. 


Steps for Custom installation utilizing a SQL Database

Before starting this process ensure that you have the User ID and password for the SQL database you will be utilizing. Additionally ensure that you have access to the location of the SQL database if it is on a different server and that servers name. This information will all be needed later during the install. As with windows it is a best practice to have a SkySync specific user for SQL and this user will need ownership rights to the SkySync database.

1)Install the version of SQL you will be using and gather the required information mentioned above

2) Download the most current version of SkySync from the link provided by your Service Representative. This link will be sent to the contact associated with the purchased license and if you are not the contact you will need to get the link from them or contact services or support to obtain a link.

3) Unzip the folder and open the SkySync application file (depending on the security settings of the computer you may need to run the file as administrator) 

4) When the Installer pops up read the License Agreement before checking the box accepting the terms. 

5) Select Custom and click Next

6)  Click Next

If SkySync needs to be installed on a Driver or location different then the standard default it can be changed here, however it is advised that this remain the default unless absolutely necessary.


7) This section configures what account the SkySync service will use to login. The default selection is "Local System Account", however it is considered a best practice to use an account specific to SkySync that is separate from the SQL connection Account. If selecting a custom account Click Validate after entering your information (Example below)

8) Click next unless utilizing a Proxy Server. 

If you are using a proxy server please read the instructions labeled Proxy Server at the end of this section before continuing.

9) Select SQL Server from the drop down menu then fill in the necessary information. 

It is considered a best practice to utilize a SkySync Specific SQL User with Ownership rights to the SkySync Database

10) Leave the Port: field blank to use the default port for SQL. If there is a resulting network issue and SQL server cannot be found, try port 1433 and verify if SQL ports are being blocked via security software/firewalls.

11) Click Validate followed by next to complete the install process

12) You will be prompted to enter your license key when first launching SkySync


Windows Defender Warning

It is possible when installing SkySync, that you will receive a message from Windows Defender blocking the install. This message can be manually bypassed by expanding the More Info.

 Expand for more information and image

This is not a cause for alarm and should stop happening in the near future. Some of our newer features resulted in the security system identifying us as a potential threat in their latest versions. Unfortunately we do not have a time frame for when the warning will stop occurring, but as mentioned it should not be the cause for alarm. 

Proxy Server/Firewall

The steps and information contained in the expand discuss utilizing a proxy server or configuring a Firewall. If this information is not needed it can be skipped. 


 Expand for more information

Firewall configuration for SkySync

SkySync requires HTTPS communication to "api.portalarchitects.com" during activation to verify your software license key.  When SkySync starts, it will also communicate with "api.portalarchitects.com" to determine if there has been any published updates to the software. Additionally communication with "windows.net", "microsoftonline.com", and "microsoftonline-p.com" will also be necessary.

Communication with cloud storage platforms vary, but in general requires standard web (port 80) and HTTPS (port 443) to be allowed through the firewall. There may also be specific configurations required for each individual connector. For more information on that the individual connectors support articles should be accessed though two have been provided below for your convenience.

Proxy Server

  • Know your proxy server's address or .pac file location. If you don't have this information, check with your IT or Network Administrators.

    • Proxy Address Example: http://<IP ADDRESS>:<PORT>/

    • Proxy Pac File URL Example: http://<IP ADDRESS>/<PROXY SCRIPT>.pac

    • It is required to use the IP address of the Proxy Server and not the FQDN.  

  • Have administrator access to the machine SkySync is installed on.

  • Remember: SkySync does not support more than one proxy server. If there are two or more proxy servers in a load balanced configuration simply use the IP Address of one of the Proxy Servers. 

Editing the Config Files

We'll be editing two configuration files, opening them in your preferred text editor (as an Administrator):

  1. <INSTALL DRIVE>:\Program Files (x86)\SkySync\skysync.exe.config

  2. <INSTALL DRIVE>:\Program Files (x86)\SkySync\skysyncservice.exe.config

Add one following snippets, replacing your necessary values, inside the <system.net> </system.net> tags,

Using IP Address and Port:


<system.net>
    <defaultProxy enabled = "true" useDefaultCredentials = "true">
    <proxy autoDetect="false" bypassonlocal="true" proxyaddress="http://<IP ADDRESS>:<PORT>" usesystemdefault="false" />
    </defaultProxy>
</system.net>

Using a Proxy Config Script (.pac):


<system.net>
    <defaultProxy useDefaultCredentials="true">
      <proxy usesystemdefault="False" scriptLocation="http://<IP ADDRESS>/<PROXY SCRIPT>.pac" />
    </defaultProxy>
  </system.net>

Save your edits to each file, and restart the SkySync service for them to take effect.

Restarting the SkySync Service 

  1. Open the Windows Services menu. (You can hit the left-hand Windows key and "R" keys together and type in "services.msc" in the run field.)

  2. Right-click on the SkySync service.

  3. Click Restart.

         

You're done. SkySync will now connect to your content sources via the new proxy settings.

Multi-Node Install


When installing multiple nodes it is important that they all utilize the same software version of SkySync. Additionally SQL Enterprise, Full SQL or SQL Express is required to utilize this install method. Additionally the SQL should be installed on a separate server not containing SkySync, and it should be kept in mind that the hardware requirements for the database will increase as the number of nodes increase. If multiple Clusters are being installed it is important to install them one cluster at a time.


1) Ensure that you have a sufficient number of activation(s) on your license key for the number of nodes you will be installing. Each node will use one activation of your license. If you are unsure about the number of activation(s) remaining on your license please contact your sales representative or Portal Architects technical support.

2) Install SkySync on the first node and activate the software. For more information on this process follow the steps above under the heading "Steps for Custom installation utilizing a SQL Database"

3) Copy the keys folder from the first node to the desktop of the computer of every other node. The default location for the keys folder is: C:\ProgramData\PortalArchitects\Data\Keys

4) Install SkySync on the rest of the nodes but do not launch or activate the software on the secondary nodes. (Ensure the option for Launch application on Exit is unchecked)

5) Stop the SkySync service on each node.

5) Overwrite the keys folder on the secondary nodes with the copy made in step 4.

6) Restart the SkySync service.

7) Enter your license key on the nodes to activate the software.

8) If installing multiple Node Clusters repeat the steps above to install the next cluster.