From 0902a10671fdd17c7db13b6646746372384490a4 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 13:53:11 +0100 Subject: [PATCH 01/18] Add README markdown template for custom projects either maintained by OpenRemote or open source users. --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 80 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0d7fc02ac..d253cc035 100644 --- a/README.md +++ b/README.md @@ -2,28 +2,96 @@ This repository 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. -## Documentation +--- -The OpenRemote documentation contains more information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, including examples you could use as a starting point. +# (PROJECT_NAME) -**[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**. +*(Please describe, in a short summary, the context of the project.)* + -## Docker Compose Files +> This repository is set up using the Custom Project template. This repository uses the same standards and folder structure. More information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, can be found in the [OpenRemote documentation](https://docs.openremote.io/docs/developer-guide/creating-a-custom-project). -In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: +## Project context + +### Features +*(Please insert a bullet point list with features specific to this custom project.)* + + +### Vocabulary / common terms +*(Please insert a bullet point list with common terms in this project, with a short explanation.)* + + +### Company background +*(If applicable, write context about the company this custom project is meant for.)* + + +## Architecture + +### Keycloak setup +The identity provider in place is [Keycloak](https://github.com/openremote/keycloak), running in its own container. The default configuration from the repository ([link](https://github.com/openremote/keycloak)) is used. + +### Proxy setup +All requests from and towards running services go through the [HAProxy](https://github.com/openremote/proxy) container. The default configuration from the repository ([link](https://github.com/openremote/proxy/blob/main/haproxy.cfg)) is used. + + + +## Developer Guide + +### Quickstart +Before starting of, make sure you have cloned the Git repository locally, as this is required. +Follow the initial guides on the OpenRemote documentation on [preparing the environment](https://docs.openremote.io/docs/developer-guide/preparing-the-environment), [installing and using Docker](https://docs.openremote.io/docs/developer-guide/installing-and-using-docker), and on [setting up an IDE](https://docs.openremote.io/docs/developer-guide/setting-up-an-ide). + + + +### Docker Compose files +In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: ```bash mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/raw/refs/heads/master/profile/deploy.yml -o openremote/profile/deploy.yml ``` +### Environment variables + +| Key | Containers | Description | Default | +|--------------------|------------|--------------------------------|----------| +| `MANAGER_VERSION` | `manager` | The OpenRemote version in use. | 'latest' | +| `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | +| `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | -## Setup Tasks -The following `OR_SETUP_TYPE` value(s) are supported: + -* `production` - Requires `CUSTOM_USER_PASSWORD` environment variable to be specified +## Deployments / environments -Any other value will result in default setup. +This custom project is deployed by OpenRemote on their managed infrastructure. It's running in Docker containers, using the `docker-compose.yml` file in the root folder of the repository. All deployments are ran using the GitHub Actions CI/CD action. + -## 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. +The list of available environments: +### `staging` +Used by OpenRemote to test new functionality and bugfixes before publishing them to production. Important practices and agreements to be aware of: +- This environment is only used for development purposes, so can be offline at any time. +- There is no guarantee that this data will be persisted in the long-term. + +- **OpenRemote Manager:** https://(staging.CUSTOM_HOSTNAME).openremote.app/manager +- **Custom app:** https://(staging.CUSTOM_HOSTNAME).openremote.app/custom + +### `production` +Used for the live system with devices in the field, with guarantee of stability and data persistence. Important practices and agreements to be aware of: +- There is a daily backup active for this instance. +- This deployment is **manually updated**, and should be communicated with stakeholders. + +- **OpenRemote Manager:** https://(CUSTOM_HOSTNAME).com/manager +- **Custom app:** https://(CUSTOM_HOSTNAME).com/custom + \ No newline at end of file From 19b11784950605b540bf7fcbe76b3f051f7eeb96 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:06:21 +0100 Subject: [PATCH 02/18] Minor tweaks --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d253cc035..e6b2bcc0e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ They use ESP32 hardware that autoprovisions in the OpenRemote platform through t This hardware gets delivered to end consumers in their homes, where they can use a dedicated app for monitoring their solar panels." --> -> This repository is set up using the Custom Project template. This repository uses the same standards and folder structure. More information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, can be found in the [OpenRemote documentation](https://docs.openremote.io/docs/developer-guide/creating-a-custom-project). +> This repository is set up using the [Custom Project template](https://github.com/openremote/custom-project/). This repository uses the same standards and folder structure. More information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, can be found in the [OpenRemote documentation](https://docs.openremote.io/docs/developer-guide/creating-a-custom-project). + ## Project context @@ -55,7 +56,7 @@ All requests from and towards running services go through the [HAProxy](https:// Before starting of, make sure you have cloned the Git repository locally, as this is required. Follow the initial guides on the OpenRemote documentation on [preparing the environment](https://docs.openremote.io/docs/developer-guide/preparing-the-environment), [installing and using Docker](https://docs.openremote.io/docs/developer-guide/installing-and-using-docker), and on [setting up an IDE](https://docs.openremote.io/docs/developer-guide/setting-up-an-ide). - +*(Please describe the steps necessary to run this custom project locally. It often requires special actions, such as creating assets manually through the Manager UI.)* ### Docker Compose files In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: From 4d1144f8a32c1750c91498ff180609451343e82f Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:11:56 +0100 Subject: [PATCH 03/18] WIP --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6b2bcc0e..1df6047d8 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/ | `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | | `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | - + ## Deployments / environments From 5380befa9c66f909cc56197d9788086ff701ae92 Mon Sep 17 00:00:00 2001 From: Martin Peeters Date: Thu, 19 Feb 2026 14:13:26 +0100 Subject: [PATCH 04/18] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1df6047d8..33d2fd12c 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/ ## Deployments / environments -This custom project is deployed by OpenRemote on their managed infrastructure. It's running in Docker containers, using the `docker-compose.yml` file in the root folder of the repository. All deployments are ran using the GitHub Actions CI/CD action. +This custom project is deployed by OpenRemote on their managed infrastructure. It's running in Docker containers, using the `docker-compose.yml` file in the root folder of the repository. All deployments are run using the GitHub Actions CI/CD action. The list of available environments: From 6db5cf93dcb506b4a2be3ffec52c3b5899f29181 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:15:04 +0100 Subject: [PATCH 05/18] Minor typo fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33d2fd12c..dc67bc067 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repository is a template for custom projects; showing the recommended proje *(Please describe, in a short summary, the context of the project.)* @@ -53,7 +53,7 @@ All requests from and towards running services go through the [HAProxy](https:// ## Developer Guide ### Quickstart -Before starting of, make sure you have cloned the Git repository locally, as this is required. +Before starting, make sure you have cloned the Git repository locally, as this is required. Follow the initial guides on the OpenRemote documentation on [preparing the environment](https://docs.openremote.io/docs/developer-guide/preparing-the-environment), [installing and using Docker](https://docs.openremote.io/docs/developer-guide/installing-and-using-docker), and on [setting up an IDE](https://docs.openremote.io/docs/developer-guide/setting-up-an-ide). *(Please describe the steps necessary to run this custom project locally. It often requires special actions, such as creating assets manually through the Manager UI.)* From 7c9b1c276a4b7d6c2593ed977537b167359888c5 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:22:42 +0100 Subject: [PATCH 06/18] Add a very dangerous line break statement --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc67bc067..fe9a867d5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This repository 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. +
+ --- # (PROJECT_NAME) @@ -56,7 +58,7 @@ All requests from and towards running services go through the [HAProxy](https:// Before starting, make sure you have cloned the Git repository locally, as this is required. Follow the initial guides on the OpenRemote documentation on [preparing the environment](https://docs.openremote.io/docs/developer-guide/preparing-the-environment), [installing and using Docker](https://docs.openremote.io/docs/developer-guide/installing-and-using-docker), and on [setting up an IDE](https://docs.openremote.io/docs/developer-guide/setting-up-an-ide). -*(Please describe the steps necessary to run this custom project locally. It often requires special actions, such as creating assets manually through the Manager UI.)* +*(Please describe the steps necessary to run this custom project locally.)* ### Docker Compose files In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: From 87641546f4adbe8c2407247ad34770096a4ca1aa Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:24:09 +0100 Subject: [PATCH 07/18] Put back original link to the documentation. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe9a867d5..d18ad0071 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository 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. -
+**[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**. --- From a2a1f60b4ce8627425285f86b59c60f8d534e665 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:25:09 +0100 Subject: [PATCH 08/18] Add back the dangerous line break statement --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d18ad0071..7df516d74 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ This repository is a template for custom projects; showing the recommended proje **[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**. +
+ --- # (PROJECT_NAME) From 06c3fc327beb3a352064812c1fff650b099b3e98 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:47:25 +0100 Subject: [PATCH 09/18] Add required environment variables, together with variables necessary for build tools --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7df516d74..0a6502331 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,14 @@ mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/ ### Environment variables -| Key | Containers | Description | Default | -|--------------------|------------|--------------------------------|----------| -| `MANAGER_VERSION` | `manager` | The OpenRemote version in use. | 'latest' | -| `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | -| `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | +| Key | Containers | Description | Default | +|----------------------|-----------------|--------------------------------------------------------------------------------------------------------------|----------| +| `OR_HOSTNAME` | All containers | **(REQUIRED)** FQDN hostname of where this instance will be exposed (localhost, IP address or public domain) | - | +| `OR_ADMIN_PASSWORD` | All containers | **(REQUIRED)** Initial admin user password | - | +| `MANAGER_VERSION` | `manager` | The OpenRemote version in use. | 'latest' | +| `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | +| `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | +| `DEPLOYMENT_VERSION` | *(build tools)* | Tag to use when building the Docker image of this custom project. | - | From 7f5013432f150911add4f4da521ec2cd800ac240 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 14:53:01 +0100 Subject: [PATCH 10/18] Updated descriptions on env vars --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a6502331..0bf57f9d3 100644 --- a/README.md +++ b/README.md @@ -70,15 +70,16 @@ mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/ ### Environment variables -| Key | Containers | Description | Default | -|----------------------|-----------------|--------------------------------------------------------------------------------------------------------------|----------| -| `OR_HOSTNAME` | All containers | **(REQUIRED)** FQDN hostname of where this instance will be exposed (localhost, IP address or public domain) | - | -| `OR_ADMIN_PASSWORD` | All containers | **(REQUIRED)** Initial admin user password | - | -| `MANAGER_VERSION` | `manager` | The OpenRemote version in use. | 'latest' | -| `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | -| `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | -| `DEPLOYMENT_VERSION` | *(build tools)* | Tag to use when building the Docker image of this custom project. | - | - +| Key | Containers | Description | Default | +|----------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------| +| `OR_HOSTNAME` | All services | **(REQUIRED)** FQDN hostname of where this instance will be exposed (localhost, IP address or public domain) | - | +| `OR_ADMIN_PASSWORD` | `keycloak`, `manager` | **(REQUIRED)** Initial admin user password | - | +| `DEPLOYMENT_VERSION` | `deployment` | **(REQUIRED)** The custom project version in use. This tag is used for building and deploying the artifacts from this repository. | - | +| `MANAGER_VERSION` | `manager` | The OpenRemote version in use. | 'latest' | +| `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | +| `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | + +A list of all environment variables from OpenRemote can be found [here](https://github.com/openremote/openremote/raw/refs/heads/master/profile/deploy.yml). ## Deployments / environments From 0e4c09cd1641c200773734bc96fabfc600608804 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Thu, 19 Feb 2026 15:02:38 +0100 Subject: [PATCH 11/18] WIP --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bf57f9d3..18c4beb6a 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,13 @@ This hardware gets delivered to end consumers in their homes, where they can use if they write Groovy scripts yes/no, if they have their own outside repository, etc. --> ## Architecture - +*(Please insert, preferably a diagram, or short explanation of the high level architecture)* + + ### Keycloak setup The identity provider in place is [Keycloak](https://github.com/openremote/keycloak), running in its own container. The default configuration from the repository ([link](https://github.com/openremote/keycloak)) is used. + ### Proxy setup All requests from and towards running services go through the [HAProxy](https://github.com/openremote/proxy) container. The default configuration from the repository ([link](https://github.com/openremote/proxy/blob/main/haproxy.cfg)) is used. From d3a09ef8e727932ae079bcbc8d57d8562572fca6 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Fri, 20 Feb 2026 10:32:41 +0100 Subject: [PATCH 12/18] Minor adjustment --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 18c4beb6a..de148ce12 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ A list of all environment variables from OpenRemote can be found [here](https:// ## Deployments / environments -This custom project is deployed by OpenRemote on their managed infrastructure. It's running in Docker containers, using the `docker-compose.yml` file in the root folder of the repository. All deployments are run using the GitHub Actions CI/CD action. +This custom project is deployed by OpenRemote on their managed infrastructure. It's running in Docker containers, using the `docker-compose.yml` file in the root folder of the repository. All deployments are run using the GitHub Actions CI/CD workflow. The list of available environments: @@ -96,8 +96,8 @@ Used by OpenRemote to test new functionality and bugfixes before publishing them - This environment is only used for development purposes, so can be offline at any time. - There is no guarantee that this data will be persisted in the long-term. -- **OpenRemote Manager:** https://(staging.CUSTOM_HOSTNAME).openremote.app/manager -- **Custom app:** https://(staging.CUSTOM_HOSTNAME).openremote.app/custom +- **OpenRemote Manager:** https://(staging.CUSTOM_HOSTNAME).com/manager +- **Custom app:** https://(staging.CUSTOM_HOSTNAME).com/custom ### `production` Used for the live system with devices in the field, with guarantee of stability and data persistence. Important practices and agreements to be aware of: From e1ba568dfd09101e4765410742ba7309a7bcd83b Mon Sep 17 00:00:00 2001 From: Martin Peeters Date: Fri, 20 Feb 2026 14:25:39 +0100 Subject: [PATCH 13/18] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index de148ce12..9a75be70f 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Follow the initial guides on the OpenRemote documentation on [preparing the envi *(Please describe the steps necessary to run this custom project locally.)* ### Docker Compose files -In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: +In the `profile` directory you can find different Docker Compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file: ```bash mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/raw/refs/heads/master/profile/deploy.yml -o openremote/profile/deploy.yml ``` From db7038cdbf3098b6f0fe5a10ef572688120df998 Mon Sep 17 00:00:00 2001 From: Martin Peeters Date: Fri, 20 Feb 2026 14:32:14 +0100 Subject: [PATCH 14/18] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a75be70f..e75dc5fb1 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/ | `KEYCLOAK_VERSION` | `keycloak` | The Keycloak version in use. | 'latest' | | `PROXY_VERSION` | `proxy` | The HAProxy version in use. | 'latest' | -A list of all environment variables from OpenRemote can be found [here](https://github.com/openremote/openremote/raw/refs/heads/master/profile/deploy.yml). +A list of all environment variables from OpenRemote can be found [here](https://github.com/openremote/openremote/blob/master/profile/deploy.yml). ## Deployments / environments From 35d5b958034ff6e2cbce258a56a935ca1c0a3d66 Mon Sep 17 00:00:00 2001 From: Martin Peeters Date: Fri, 20 Feb 2026 14:32:22 +0100 Subject: [PATCH 15/18] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e75dc5fb1..d890e9435 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ This hardware gets delivered to end consumers in their homes, where they can use if they write Groovy scripts yes/no, if they have their own outside repository, etc. --> ## Architecture -*(Please insert, preferably a diagram, or short explanation of the high level architecture)* +*(Please insert, preferably a diagram, or a short explanation of the high level architecture)* ### Keycloak setup From ac7bb074131da4161d2ad7168954de24a64b3640 Mon Sep 17 00:00:00 2001 From: Martin Peeters Date: Fri, 20 Feb 2026 14:32:41 +0100 Subject: [PATCH 16/18] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d890e9435..7cdf06104 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The identity provider in place is [Keycloak](https://github.com/openremote/keycl ### Proxy setup -All requests from and towards running services go through the [HAProxy](https://github.com/openremote/proxy) container. The default configuration from the repository ([link](https://github.com/openremote/proxy/blob/main/haproxy.cfg)) is used. +All requests from and towards running services go through the [HAProxy](https://github.com/openremote/proxy) container. The default configuration from the repository ([haproxy.cfg](https://github.com/openremote/proxy/blob/main/haproxy.cfg)) is used. From 2164e82b0efc19b7a46f8ca428fffac83b11cad2 Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Mon, 23 Feb 2026 16:56:47 +0100 Subject: [PATCH 17/18] Address spelling errors --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7cdf06104..48a55827e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenRemote Custom Project Template -This repository 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. +This repository 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 customize each part. **[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**. @@ -11,14 +11,14 @@ This repository is a template for custom projects; showing the recommended proje # (PROJECT_NAME) *(Please describe, in a short summary, the context of the project.)* - -> This repository is set up using the [Custom Project template](https://github.com/openremote/custom-project/). This repository uses the same standards and folder structure. More information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, can be found in the [OpenRemote documentation](https://docs.openremote.io/docs/developer-guide/creating-a-custom-project). - +> This repository is set up using the [Custom Project template](https://github.com/openremote/custom-project/). This repository uses the same standards and folder structure. More information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps can be found in the [OpenRemote documentation](https://docs.openremote.io/docs/developer-guide/creating-a-custom-project). + ## Project context @@ -45,7 +45,7 @@ if they write Groovy scripts yes/no, if they have their own outside repository, ## Architecture *(Please insert, preferably a diagram, or a short explanation of the high level architecture)* - + ### Keycloak setup The identity provider in place is [Keycloak](https://github.com/openremote/keycloak), running in its own container. The default configuration from the repository ([link](https://github.com/openremote/keycloak)) is used. @@ -100,7 +100,7 @@ Used by OpenRemote to test new functionality and bugfixes before publishing them - **Custom app:** https://(staging.CUSTOM_HOSTNAME).com/custom ### `production` -Used for the live system with devices in the field, with guarantee of stability and data persistence. Important practices and agreements to be aware of: +Used for the live system with devices in the field, with a guarantee of stability and data persistence. Important practices and agreements to be aware of: - There is a daily backup active for this instance. - This deployment is **manually updated**, and should be communicated with stakeholders. From 488418226e912ce66775f283b9f53a7dd92e9d1d Mon Sep 17 00:00:00 2001 From: MartinaeyNL Date: Mon, 23 Feb 2026 16:59:58 +0100 Subject: [PATCH 18/18] Removed br tag, and added structure to company background chapter --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 48a55827e..efb77888b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ This repository is a template for custom projects; showing the recommended proje **[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**. -
--- @@ -40,8 +39,13 @@ This hardware gets delivered to end consumers in their homes, where they can use ### Company background *(If applicable, write context about the company this custom project is meant for.)* - + ## Architecture *(Please insert, preferably a diagram, or a short explanation of the high level architecture)*