Skip to content
Paul Montgomery edited this page Aug 12, 2021 · 13 revisions

How to package the app:

Windows

Run npm run package:win this will create a executable installation, an msi installation, and a stand-alone executable in the dist dirctory based on the version number in the package.json file.

Linux

Run npm run package:linux this will create snap and AppImage installations as well as tar.gz, tar.lz, and tar.xz formats. Changes to build.linux.target array entries can be used to only build specific output types.

Raspberry Pi

Running on a Raspberry Pi is not supported. If you are going to run on a Raspberry Pi, however, we recommend running on a Raspberry Pi 4B with at least 4GB of RAM and Ubuntu Desktop or Raspbian. You can run npm run package:linux as mentioned in the Linux instructions or npm run build && npm run electron to build and execute the electron application directly. On most clean installations, NPM is not installed. Therefore, you may have to run sudo apt-get update and sudo apt-get install npm before being able to build the application.

Macintosh

Run npm run package:mac this will create dmg installations suitable for Macintosh OSX as well as mountable application.

Linux on Windows via Docker

Ensure your Docker environment is set up appropriately. Run npm run docker to pull and launch the electronland/electron-builder image and launch the current working directory as /. Some environments require $(pwd) to be replaced with the actual host directory. You can make the change as needed in package.json.

Once the electron-builder environment is loaded, run npm run package:linux to create the Linux installations as you would in a full Linux environment.

How to solve 'Port is in use'

The port our app use may have already been taken by another process, or possibly being blocked by some firewall or proxy settings.

You can either free up the port or set up a custom port to use.

To configure a custom port value, set system environment variable 'AZURE_IOT_EXPLORER_PORT' to an available port number.

Whenever the port value is updated, please remember to restart the app.

A side note, you may have to restart the app twice, as sometimes the previous process has not been completed stopped.