Deployment Notes

Single User Installation

The simplest deployment is for a single machine, but there are some differences to note between Windows and Mac:

Windows releases are distributed as a setup file (administrator privileges should not be required as it installs to the user's AppData directory by default).
New installations overwrite previous installations; thus to upgrade the user should first export their data through the application, and then import this data after the new version is installed.
Windows explorer has trouble with path lengths that exceed 255 characters; since this limit is often exceeded by the KoNote data directory, it cannot be deleted manually. To remove KoNote, the user should use the uninstaller (via Control Panel > Programs > Uninstall). The uninstaller is just an nwjs app that deletes the data directory. On Windows 10, the max length limit can be removed with the “Enable Win32 long paths” group policy, or setting the registry value HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem@LongPathsEnabled to 1.

Mac releases are distributed as a DMG archive containing the KoNote.app file. To install just drag the app to the desired location (typically Applications)
KoNote's data directory is internal to the app file. Thus replacing the app with a new version will overwrite the user's data. To upgrade, the user should export their data through the application and then import this data after the new version is installed.

In networked environments, the following information should be noted:

On Windows, the zip release should be preferred over the setup file to control the installation path.
KoNote's data directory can be defined in the config file (defaults to application-root/data). On Windows, backslashes in the path string should be escaped. Ex: D:\\konotedata
To ensure application security some access control is required at the filesystem. Specifically, file permissions should be configured on the KoNote directory and data directory as follows:
READ + CREATE ONLY for normal users
WRITE permissions granted to administrators on the data/users directory (to create new users, modify user account types, and delete account keys)
WRITE permissions granted to [application] administrators on the application directory (required to perform upgrades of KoNote)

Backup the /data/ directory somewhere safe. The recommended way to do this is from within the app: Menu > Export Data > Backup all data to zip (*note that due to the path length restrictions on Windows you should not copy and paste the directory via Windows Explorer and/or use Windows zip. 7zip is supported)
Close KoNote and then install the new version.
Start KoNote. On the new installation screen, select "Import Backup". If a migration is required, KoNote will prompt for administrator credentials. Once the data has been upgraded, KoNote will restart.

Install the SDK build of KoNote, and copy the /data/ backup into the appropriate location (as defined by the config)
Open KoNote, do not log in.
Open devTools console (Ctrl + Shift + J or right-click and Inspect Background Page)
run m = require('./migrations')
run m.runMigration('DATA-DIRECTORY', 'FROM-VERSION', 'TO-VERSION', 'USERNAME', 'PASSWORD', null)
- User must be an admin account
- Data directory is relative path from KoNote app directory
After the migration is complete, clear the app cache nw.App.clearCache();

We are developing instructions for Remote Desktop Deployments. Please contact [email protected]