Preparing the environment
To build OpenRemote projects, you have to first prepare the environment on your developer workstation or build machine. Alternatively you can use a Docker image with tooling.
Ensure you have installed and configured the following tools:
Runtime tooling
OpenRemote is primarily packaged as Docker images and deployed using Docker Compose, you will need a docker compatible runtime:
Docker Desktop includes Docker Compose. If you install Docker Engine separately, also install the Docker Compose plug-in.
Ensure the following commands execute successfully:
docker -v
docker compose version
Development tooling
For development you need the following in addition to the runtime tooling:
- Java 21 JDK (OpenJDK, Oracle Java SE JDK)
- Git
- Git LFS
git lfs install - NodeJS (>=20.19, on macOS you can use Homebrew and
brew install node@20) - yarn
corepack enable; yarn init -2(>=3.2.0)
Ensure the following commands execute successfully:
java -version
git --version
node -v
yarn -v
Ensure that you have the JAVA_HOME environment variable set to the path of JDK.