Repository navigation
Developer Guide: Preparing the environment
To build OpenRemote projects, you have to first prepare the environment on your developer workstation or build machine.
Ensure you have installed and configured the following tools:
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):
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
For development you need the following in addition to the runtime tooling:
- Java 8 JDK (OpenJDK, Oracle Java SE JDK, on MacOS use AdoptOpenJDK)
- GIT
-
NodeJS (>= 10.13.0, on MacOS you can use Homebrew and
brew install node@10) -
yarn
npm install --global yarn(>=1.12.1)
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.
Alternatively to tooling above there is a docker image with all tools required to build the stack. You don't have to install anything other than docker and be sure that tooling version is the same as our CI/CD pipeline. This can be very useful when you need to use other machine, e.g. deployment host.
Check current version:
docker run --rm -v `pwd`:/or registry.gitlab.com/openremote/openremote:master git status
Build the stack:
docker run --rm -v `pwd`:/or registry.gitlab.com/openremote/openremote:master ./gradlew clean installDist
Source · Documentation · Forum · Issues · Docker Images · OpenRemote Inc.