openremote / custom-project

Template repo for creating an OpenRemote custom project

Custom Project

This repo is a template for custom projects; showing the recommended project structure and including README files in the deployment directory to provide details about how to customise each part.

Setup Tasks

The following OR_SETUP_TYPE value(s) are supported:

• production - Requires CUSTOM_USER_PASSWORD environment variable to be specified

Any other value will result in default setup.

Encrypted files

If any encrypted files are added to the project then you will need to specify the GFE_PASSWORD environment variable to be able to build the project and decrypt the files.

custom-project's Issues

javax needs to be changed to jakarta

In CustomAsset, CustomEndpointResource, CustomAgent
@richturner, otherwise custom-project won't compile

Build stuck on `:openremote:ui:component:or-icon:copyMdiFont`

Running a clean clone of the custom-project template using:
./gradlew clean installDist --info

I get:

> Task :openremote:ui:component:or-icon:copyMdiFont FAILED
Caching disabled for task ':openremote:ui:component:or-icon:copyMdiFont' because:
  Build cache is disabled
Task ':openremote:ui:component:or-icon:copyMdiFont' is not up-to-date because:
  Task has not declared any outputs despite executing actions.
Starting process 'command 'npm''. Working directory: /home/reven/openremote/openremote/ui/component/or-icon Command: npm run copyMdiFont
:openremote:ui:component:or-icon:copyMdiFont (Thread[Execution worker for ':' Thread 4,5,main]) completed. Took 0.006 secs.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':openremote:ui:component:or-icon:copyMdiFont'.
> A problem occurred starting process 'command 'npm''

Trying to figure out how to build and start a production environment.

gradlew missing executable acl

The gradlew file is missing the executable bit.

-rw-rw-r--

should be:

-rwxrwxr-x

custom-project/docker-compose.yml

Line 15 in 9479eb1

# ./gradlew clean installDist

Otherwise this 'guide' can't be followed by copy-pasting.

Gradle does not start building custom components (ui/component/*)

There is a custom application and a custom UI component package. Here is the structure

Executing the command ./gradlew clean installDist, the build crashes.

The problem is that cradle starts building a custom application when the package of a custom component is not built.

You can see that the gradle installDist task was completed in the package of the custom component, but the package was not built.

The root package.json contains an indication of ui/component as a workspace, and an additional indication of the order of workspaces has no effect

StackOverflowError on first build

Describe the bug
The build failed with StackOverflowError message on fresh copy of the repository

To Reproduce
Steps to reproduce the behavior:

1. git clone [email protected]:openremote/custom-project.git
2. cd custom-project/
3. git submodule init
4. git submodule update
5. chmod u+x gradlew
6. ./gradlew eclipse

Screenshots

Setup information:

• OS: Ubuntu 22.04
• java version "17.0.4"
• OpenRemote v3