Articles in this section

OneSync Setup Requirements

   Product:  OneSync   

Audience: ClassLink Administrator

 

 OneSync is a user provisioning tool that can import, edit, manage, and export user accounts. You can import users from a source, manage the users and their properties with OneSync, and export the modified user accounts to a destination.

 

Note: OneSync is user management not a directory management system. 

 

 

Overview 

 

 

OneSync Server 

*Optional* To access the OneSync web app outside the server:

  • Install SSL certificate (.pfx) in IIS
  • DNS Entry
  • Site bound to port 443

 

Software Requirements 

  1. Operating System: Windows Server 2016 or later.
  2. Install Google Chrome.
  3. If you are using a WSUS server, ensure that IIS packages are available.
  4. All latest Windows updates installed.

 

Notes: Windows Server 2012R2 entered "extended support" on 10/9/2018. Because of this, we recommend installing OneSync on Windows Server 2016 or later.

If you are running OneSync on Windows Server 2012 R2, please make sure that you install Update for Windows Server 2012 R2 (KB2999226) prior to installing OneSync. This can be installed via windows updates or by following the above link.

 

Hardware Requirements 

Use the following table as a guideline for the server’s specs:

(physical or VM) recommended requirements*

Total users RAM CPU Storage
< 5,000 4 GB 4 cores 80 GB
> 5,000 < 40,000 8 GB 8 cores 120 GB
> 40,000 16 GB 16 cores 160 GB

 

Whitelist Resources 

Ensure that the following resources are accessible:

  • https://cdn.classlink.com:443
  • https://onesync.classlink.com:443
  • https://support.classlink.com:443
  • https://fonts.googleapis.com:443
  • https://fonts.gstatic.com:443
  • https://kit.fontawesome.com:443
  • https://kit-pro.fontawesome.com:443
  • https://unpkg.com:443
  • https://stabledists.classlink.com:443
  • https://dists.classlink.com:443
  • https://api.sendgrid.com:443
  • https://onesync-management-service.classlink.io:443
  • https://downloads.mariadb.com:443
  • https://download.visualstudio.microsoft.com:443
  • https://download.microsoft.com:443
  • amqp://oms-mq-prod.classlink.io:5671 (or 443)

 

 

Active Directory Test Environment

Note: This AD Test environment will be used to execute trials, establish performances and reliability before it is taken into your AD Production environment. 

  1. Build an Active Directory server  - Domain controller for a new domain (must be in a new forest, can be within the same IP range). 
  2. Install all the latest Windows updates.
  3. Join OneSync Test Server to AD Test Domain.
  4. Replicate production AD password policy on the AD Test server.

 

 

Determine Data Source

Sources are pre-existing directories or files that contain user data. You will import this user data from your sources to create user accounts in OneSync. 

Valid sources include:

  • *Recommended* CSV file - You can download a Sample CSV at the bottom of this article or create your own CSV file using programs such as, but not limited to, NotePad or Microsoft Excel. 
    • Field names are not critical as they will be mapped in OneSync. 
  • Classlink Roster Server - need to have access to manage the Roster Server. 
  • *Advanced* ODBC (Open Database Connection) - an API for accessing database management systems, which allows OneSync to connect and import from your database directly. 
    • You will need connection information and a query.

 

Note: Please fill out the form in order to identify the user data needed in your OneSync source.

 

Updated: Jan 2020

Related articles