Installation Open Remote

Argon · February 26, 2025, 3:09pm

Hi guys! Im wondering if someone can shed some light on the installation process with some details.

I made a new github repository from where i cloned the “custom-project”.

Ive prepared th enviroment according to Preparing the environment | OpenRemote Documentation

java -version = java version “23.0.2” 2025-01-21
git --version = git version 2.48.1.windows.1
node -v = v23.8.0
yarn -v = 1.22.22

Ive installed docker and it seems to be running

C:\Users\Ruan\Desktop\CustomOpenRemote>docker -v
Docker version 27.5.1, build 9f9e405

C:\Users\Ruan\Desktop\CustomOpenRemote>docker-compose -v
Docker Compose version v2.32.4-desktop.1

When i go to setup the IDE like Setting up an IDE | OpenRemote Documentation

im given the error of it cant locate the file in the path specified.

C:\Users\Ruan\Desktop\CustomOpenRemote>docker-compose -p openremote -f C:\Users\Ruan\Desktop\CustomOpenRemote\openremote\profile\dev-testing.yml up --build -d
open C:\Users\Ruan\Desktop\CustomOpenRemote\openremote\openremote\profile\deploy.yml: The system cannot find the path specified.

C:\Users\Ruan\Desktop\CustomOpenRemote>docker-compose -p openremote -f profile/dev-testing.yml up --build -d
open C:\Users\Ruan\Desktop\CustomOpenRemote\profile\dev-testing.yml: The system cannot find the path specified.

The file is located in the directory “C:\Users\Ruan\Desktop\CustomOpenRemote\openremote\profile\dev-testing.yml”

These are both the attempts made and im not sure why it cant locate the file. Any help would be greatly appretiated.

martin.peeters · February 26, 2025, 3:43pm

Hi! First of all, welcome to the forum!

After cloning the repository, it creates a new folder called openremote.
This is where all the code of your custom project lives, and it’s the location all commands should
be executed from.

So, move inside the /openremote directory, and you should be good to go!

cd openremote
docker-compose -p openremote -f profile/dev-testing.yml up --build -d

Argon · February 27, 2025, 6:10am

Hi Martin thanks so much for the response,

the issue is still persisting… Also some other information when i was cloning the custom-deployment from the github here it creates a file called custom-project not openremote. I’m not sure if this could maybe be where the problem stems from but yeah…

I’ve also tried to change the name of this file to “openremote” but this also unfortunately doesn’t solve the issue. The “docker-compose -p openremote -f profile/dev-testing.yml up --build -d” command then just looks for 2 “openremote” directories.

If its any help heres the cmd log

C:\Users\Ruan\Desktop\Open Remote Custom App>git clone GitHub - openremote/custom-project: Template repo for creating an OpenRemote custom project
Cloning into ‘custom-project’…
remote: Enumerating objects: 849, done.
remote: Counting objects: 100% (327/327), done.
remote: Compressing objects: 100% (145/145), done.
Rremote: Total 849 (delta 198), reused 213 (delta 154), pack-reused 522 (from 2)
Receiving objects: 100% (849/849), 2.99 MiB | 4.77 MiB/s, done.
Resolving deltas: 100% (304/304), done.

C:\Users\Ruan\Desktop\Open Remote Custom App>cd openremote

C:\Users\Ruan\Desktop\Open Remote Custom App\openremote>git submodule init

C:\Users\Ruan\Desktop\Open Remote Custom App\openremote>git submodule update --rebase --remote

C:\Users\Ruan\Desktop\Open Remote Custom App\openremote>docker-compose -f profile\dev-testing.yml up --build -d
open C:\Users\Ruan\Desktop\Open Remote Custom App\openremote\openremote\profile\deploy.yml: The system cannot find the path specified.

C:\Users\Ruan\Desktop\Open Remote Custom App\openremote>docker-compose -p openremote -f profile\dev-testing.yml up --build -d
open C:\Users\Ruan\Desktop\Open Remote Custom App\openremote\openremote\profile\deploy.yml: The system cannot find the path specified.

Any help would be appreciated. Thanks in advance

Argon · February 27, 2025, 6:55am

I have been playing around a bit it seems my problem stems from the submodules not being created within the custom-project file.

When using “git submodule init” and “git submodule update --rebase --remote” there seems to be no response from my cmd.

Thanks in advance for any help provided

Rich · February 27, 2025, 10:51am

Hi, we don’t use submodules any longer from the custom projects, if you can let us know where this is still mentioned in the docs we can look to correct.

Custom projects pull in the main repo dependencies as jar artefacts from maven.

We still have issues with the docker compose files in the custom project template repo referencing the old submodule, you need to get these compose files from the main repo until we provide a cleaner solution.

Hope this clears up some things.

ebariaux · February 27, 2025, 1:29pm

So to get those compose files from the main repo, you need to clone the main repo separately.
And the folders for main repo and your custom project should be siblings.

So doing
git clone GitHub - openremote/custom-project: Template repo for creating an OpenRemote custom project
git clone GitHub - openremote/openremote: 100% open-source IoT Platform - Integrate your devices, create rules, and analyse and visualise your data

And then going inside custom-project to run the docker compose command should get you going.