preparing-the-environment.md

sidebar_position
1

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

To run docker images from Docker Hub you need to install the following tooling:

• Docker see here

If you want to manage remote Docker engines then you will also need to install docker-machine separately (since docker 2.2.x):

• Docker machine

Ensure the following commands execute successfully:

docker ps
docker-compose version

If you installed Docker machine then make sure the following command executes successfully:

docker-machine version

Development tooling

For development you need the following in addition to the runtime tooling:

• Java 17 JDK (OpenJDK, Oracle Java SE JDK)
• Git
• NodeJS (>=18.12.0, on macOS you can use Homebrew and brew install node@18)
• 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.

See also

• Installing and using Docker
• Next 'Get Started' step: Build the code and run the manager
• Get Started