📄️ 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.
📄️ Installing and using Docker
All OpenRemote projects are delivered as Docker images that support linux/aarch64 and linux/amd64, you'll need a Docker host to run containers and service stacks.
📄️ Setting up an IDE
This guide helps you set up an environment with an IDE when you are done Preparing the environment, so you can work comfortably on the Manager backend services.
📄️ Building and testing
Building
📄️ Working on UI and apps
Overview
📄️ Working on maps
Vector maps (Mapbox GL)
📄️ Docker Compose profiles
Docker services
📄️ Creating a custom project
Quickstart
📄️ Maintaining an installation
Monitoring
📄️ Adding Widgets on Insights
Manager UI
📄️ Working on the mobile consoles
The OpenRemote mobile consoles load the web applications using a web view and provide bridging of native device functionality to provide a native app experience.
📄️ Connecting Protocol adaptors with Agents
The Agent asset is special: you create it to connect some services or devices to the OpenRemote context, so you can manage them as assets, too. It's the glue in OpenRemote that lets you connect external services to the asset model, you connect sensors and actuators.
📄️ Licensing guidelines for contributors
All projects should include a LICENSE.txt text file in the root folder. This file should also be in the root of any distributed archive/ZIP file.
📄️ Useful commands and queries
Docker
📄️ Data migration
Sometimes it is desirable to bulk edit existing assets (add/remove attributes and/or configuration items) rather than wiping the DB and starting again.
📄️ Gateway tunnelling setup
This guide describes the steps necessary to setup the gateway tunnelling functionality which allows remote access to edge gateways using SISH
📄️ Frontend Testing
OpenRemote uses Playwright for frontend testing. Playwright was originally created for end-to-end testing i.e. testing through a browser just like how users would interact with an application. This usually requires the backend to run, making end-to-end tests considerably slower than unit- or component tests. Playwright has added an experimental feature for component testing. This allows you to use the same Playwright APIs on individual components for better test isolation and easier parallelization.