Docs / Installation

Install NodalDesk.

The recommended path is to use release packages. NodalDesk is meant to reach the end user as a self-contained app, without asking them to manually install capture, audio or input pieces.

Back to docs First use

Linux

Host and desktop client

Linux is one of the supported desktop hosts (alongside Windows): a machine you can control natively from another device.

Planned release formats: AppImage, deb, rpm and pacman.
The package must include its Electron runtime and the runtime-tools/ bundle for the native Linux host helpers.
If that bundle is missing from a final package, it's a packaging problem, not something the user should fix by installing dependencies by hand.

Windows

Desktop host & client

On Windows, NodalDesk works as a host (the machine you control) and also as a client to connect to other Linux, Windows or Android hosts.

Release formats: .exe installer and portable .exe.
The Windows host captures the screen and injects keyboard/mouse natively.
Not signed yet: SmartScreen may ask "More info → Run anyway".

macOS

Desktop client

On macOS, NodalDesk is distributed as a desktop app to get into controllable machines.

Planned release format: dmg.
macOS is a self-contained client in the current state.
The native macOS host isn't documented as supported today.

Android

Client and native host

Android uses a native app. It can be used to control other machines and also has its own host mode inside the APK.

Planned release format: apk.
If you install outside a store, Android may ask you to allow installs from external sources.
The app uses touch gestures, zoom, two-finger scroll and an on-screen QWERTY keyboard for remote sessions.

Development

Install from source.

The flow from the repository exists for development and testing, not as the main story for end users.

npm install
node bin/nodaldesk --help

To test a local native bundle on Linux you can point the runtime at a specific folder:

NODALDESK_RUNTIME_TOOLS_DIR=/absolute/path/to/runtime-tools node bin/nodaldesk