Setting Up Development Environment

July 8, 2025 ยท View on GitHub

Requirements

  • yarn >= 1.22
  • Node.js >= 20.19
  • Running instance with TrueNAS nightly (VM is fine).

Tip

master branch usually corresponds to TrueNAS nightly, but you may be able to run master WebUI on non-master TrueNAS instance, if it's relatively new.

Getting The Code

  • Clone WebUI repo:
$ git clone <url of webui repo or your fork>
$ cd webui
  • Install packages:
$ yarn
  • Create an environment file and point it to your TrueNAS instance:
$ yarn ui remote -i <ip address or hostname of the server where TrueNAS is running>

Tip

If there is something wrong with your environment file, you can reset it with yarn ui reset and then execute yarn ui remote -i again.

Starting the Application

  • Start WebUI in development mode:
yarn start