NGDesktop Export Wizard
Reference documentation for war export wizard
Overview
The NGDesktop Export Wizard streamlines the creation of platform-specific installers for Servoy applications, allowing for tailored deployments based on user preferences. After configuration, the wizard sends a request to a cloud service, which then compiles and returns the appropriate installer. For Windows, it provides an executable installer with optional updates; for macOS, a signed DMG; and for Linux, a tar.gz archive. Both x86/x64 and ARM configurations are supported. Users are notified via email about the location of the installer and related files.
Options
Servoy application URL Specifies the web address of the Servoy Developer application hosted on the server. This URL is used to load the application within the NGDesktop client
Platform Determines the specific operating system for which the binaries are compiled. Since 2024.03.1 version, both x86/x64 and ARM architectures are supported in order to accommodate a wider range of hardware. For Windows, an executable installer is provided, with the option to include an updater. For macOS, a signed DMG ensures secure distribution, while for Linux, a tar.gz archive is used. Each format is tailored to meet the standard deployment practices of the respective platform.
Icon path Specifies the path to the logo file used for the NG Desktop client. The file should be in PNG format and must not exceed a size of 256KB. If no custom logo is provided, the default Servoy logo is used.
Image path Specifies the path for the installer image (Windows only). The recommended image size is 164 x 314 pixels, and the file must not exceed 512KB in size. This image is displayed during the installation process. If no custom image is provided, a default image supplied by Servoy is used.
Copyright This field is designated for entering the copyright information associated with the application. It supports a maximum of 128 characters.
NG Desktop size This field sets the default dimensions of the NGDesktop application's main window upon its first launch. If no values are specified, the window will default to a size of 1000 x 800 pixels. This ensures that the application displays properly sized and configured for initial user interaction.
Version
This field allows you to select from the available NGDesktop versions compatible with the current developer release. Choosing 'latest' will automatically select the most recent version available, ensuring that you are using the newest features and updates.
Application name NGDesktop application name
Include update (Windows) This option, when checked, includes the auto-updater binary next to the installer. Detailed instructions on how to use the auto-updater are also provided.
Update location Specify the server address for the update server. It's important to maintain the same address throughout the NGDesktop application's lifecycle. A change in this address requires a fresh installation of the NGDesktop application to maintain update functionality.
Email address Enter the email address that the cloud NGDesktop service will use to notify the user about the location of the provided binaries and files.
Store artifacts for 7 days If this option is checked, the binaries and files will be stored for 7 days. If unchecked, they will be deleted after 2 hours.
Notes
This feature is accessible only to registered users. The wizard initiates a request to the NGDesktop service running in the Servoy Cloud. Upon successful registration of the request, a confirmation dialog is received, indicating that the process has been completed:
NGDesktop Update Process
During the initial installation, the NGDesktop client records the provided update URL. Each time the application is launched, it checks this URL for updates, downloading any available updates in the background. Users are notified when an update has been downloaded and a restart is required to apply the update. The update package includes two key files: a binary file and a latest.yml file that contains information related to the update. Both files must be placed at the specified location in the update URL. For ARM64 architectures, the binaries should be placed in a subdirectory named arm64 at the same update location. Note that changing the update location after installation is not possible without reinstalling NGDesktop.
Last updated
