The on-board app is set up from Vessel Settings → On-board app. Only Nauticare administrators can see this tab, so company staff and crew never see it. Installing and removing the on-board app is arranged with Nauticare, not done by the customer.
The tab
It has three sections, with the lifecycle button at the bottom:
- Status: Vessel mode (shown as
CLOUD_ONLY,INSTALLING,VESSEL_MANAGEDorDECOMMISSIONING), Managed since, and Last sync, which is when the yacht last sent changes up. - Device: the on-board server registered for this yacht. See The Registered Device and Its Token.
- Sync errors: anything the yacht sent that the cloud has not applied. See Sync Errors.
Install on-board app appears only while the yacht is cloud-only. Decommission replaces it once the yacht is vessel-managed. Neither button shows while an install or decommission is in progress.
The install wizard
Install on-board app opens a wizard with four steps.
1. Confirm. It explains what is about to happen: cloud-side edits for the yacht are locked, and the IT operator must have the yacht's server ready. Start install commits. From this moment the yacht is installing. Maintenance, Tasks and Inventory are already read-only in the cloud, with the yellow banner showing.
2. Credentials. The wizard gives you a set of one-time values for the person installing on the yacht's hardware: a seed download link, a device token, an install secret and a checksum, plus the full command that uses them. They are shown only once and are not stored. If you close the wizard before the operator has them, the only way forward is to start over. The seed link expires 24 hours after it is issued. I've started install.sh moves on.
3. Waiting. The wizard watches for the on-board server to contact the cloud, refreshing by itself about once a minute. Confirm online stays disabled until that first contact. Then the wizard shows when the yacht reached the cloud, and the button becomes available.
4. Done. Confirm online makes the yacht vessel-managed, the wizard confirms the on-board app is live, and Done closes it. The cloud only accepts this once the yacht has successfully sent up its first change, not just made contact. If it has not yet, the wizard shows Confirm failed. Make sure the install script finished without errors. Wait a little and try again.
Cancelling
Cancel on the first step just closes the wizard, because nothing has happened yet. Cancel on the credentials or waiting step aborts the install and returns the yacht to cloud-only, releasing the read-only lock in the cloud. Any credentials already handed out stop working.
Use Cancel rather than closing the window. Closing the wizard part-way through does not abort the install. The yacht stays in installing mode, read-only in the cloud, and the tab has no button to resume or cancel it.
Rules the wizard enforces
- An install can only start from a cloud-only yacht.
- A yacht can have only one active on-board server at a time. If one is already registered, a new install is refused.
- Two administrators cannot start an install for the same yacht at once. The second attempt is rejected rather than silently issuing a second set of credentials.
Installing on the yacht's hardware is an IT procedure and is documented separately.