Product: OneSync
Audience: ClassLink Administrator
OneSync updates are released periodically in order to add to new features, fix bugs, and patch security holes. There are multiple ways to update OneSync, each with its own benefits.
Overview
Available Updates
You can automatically update OneSync from the frontend by navigating to OS Settings > General Settings. Here, in the upper right-hand corner, you will see your Current Version of OneSync. If an update is available, you will see the update's version number in red. Alongside this will be a blue "Update OneSync" button.
In General Settings, there is an additional setting labeled "OneSync Preview Features". If Enabled, this setting will update OneSync with the latest preview features. Note that these updates may not be stable because they have not been extensively tested. If Disabled, this setting will update OneSync with the latest stable build. This includes features that have been thoroughly tested and approved.
Command Line Updater
You can manually update OneSync by running the updater's executable file from the command line. To do so, open a command prompt and navigate to the directory that contains the executable file. If possible, run the command prompt as administrator. Once in the directory, you can type "OSUpdater.exe" to initiate the update. You can also type "OSUpdater.exe --help" to see a list of commands that you can perform from the command line:
- backup: Backup the database and application files.
- deleteallthedata: Delete all user data, leaving the config.
- restore: Restore the database interactively.
- securewindows: Disable known-insecure protocols and hashes like TLS 1.0 and SSL 2.0 and 3.0.
- update: Update OneSync (Default Command)
These commands can be run by typing "OSUpdater.exe [command]". Additionally, you can type "OSUpdater.exe [command] --help" to read more instructions and details about each command. E.g. "OSUpdater.exe restore --help".
Graphical User Interface (GUI) Updater
You can manually update OneSync by running the OSUpdaterGUI.exe file. This will open a user-friendly program which you can use to run the same commands that you would with the Command Line Updater, but without typing the commands. There are also additional commands in the GUI updater that are not as easily run in the Command Line Updater:
- Install: Install OneSync which goes through the requirements and dependencies that are already installed/need to be installed.
- Update: Update OneSync with the option to backup your database and application files.
- Backup: Backup your database and application files without updating.
- Restore: Restore your database and/or application files. You can browse for the specific backup files.
- Advanced:
- Update: Advanced update allows for the options to download but doesn't install, back up the database, backup the application files, delete backups after a specified number of days, skip securing windows, specify a zip file to update from, or specify a version number to update to.
- Backup: Similar to the regular backup tab which contains options to backup the application files and backup the database but includes delete backups after a specified amount of days option as well.
- Configure Database: The credentials for the database OneSync is using (this has default values that are set when OneSync was installed but can be overwritten)
- Delete User Data: This will clear out all of the user data within your OneSync database and has options for backing up the database and application files.
- Secure Windows: Has options for securing server protocols, client protocols, as well as ciphers and hashes.
- Manage Background Tasks: This tab will either remove or repair any background tasks.
- Settings: Choose light or dark mode for the GUI Updater.
- About: Displays the Updater's version number.
Updated: Oct 2019