OpenRemote v3

Source · Documentation · Forum · Issues · Docker Images · OpenRemote Inc.

Welcome to the OpenRemote 3.0 platform; an intuitive user-friendly 100% open source IoT platform. We have our origins in Home Automation but our 3.0 platform is focused on generic IoT applications and is a completely different stack to any of our 2.x services. As the code base is 100% open source then the applications are limitless. Here's an architecture overview:

Quickstart

You can quickly try the online demo with restricted access, login credentials are smartcity:smartcity:

Online demo

The quickest way to get your own environment with full access is to make use of our docker images (both amd64 and arm64 are supported).

Make sure you have Docker Desktop installed (v18+).
Download the docker compose file: OpenRemote Stack (Right click 'Save link as...')
In a terminal cd to where you just saved the compose file and then run:

    docker-compose pull
    docker-compose -p openremote up

If all goes well then you should now be able to access the OpenRemote Manager UI at https://localhost. You will need to accept the self-signed certificate, see here for details how to do this in Chrome (similar for other browsers).

Login credentials

Username: admin
Password: secret

Changing host and/or port

The URL you use to access the system is important, the default is configured as https://localhost if you are using a VM or want to run on a different port then you will need to set the OR_HOSTNAME amd OR_SSL_PORT environment variables, so if for example you will be accessing using https://192.168.1.1:8443 then use the following startup command:

BASH:

OR_HOSTNAME=192.168.1.1 OR_SSL_PORT=8443 docker-compose -p openremote up -d

CMD:

cmd /C "set OR_HOSTNAME=192.168.1.1 && set OR_SSL_PORT=8443 && docker-compose -p openremote up -d"

NOTE: When chaning OR_SSL_PORT you will need to alter the KEYCLOAK_FRONTEND_URL in the docker-compose.yml file (see comments in the file for details)

What next

Try creating assets, agents, rules, users, realms, etc. using the Manager UI, please refer to the wiki for more information, some things to try:

Manager UI Guide - Learn more about the User Interface
Creating an HTTP Agent tutorial - Connect to an online weather service
Custom Deployment - Style the Manager to your brand
Setting up an IDE - Set up your development environment
Working on the UI - Create a web application compatible with OpenRemote
Creating a custom project - Create a project with custom protocols, asset types and setup code

Where's the data stored?

Persistent data is stored in a PostgreSQL DB which is stored in the openremote_postgresql-data docker volume which is durably stored independently of the running containers (see all with docker volume ls). If you want to create a backup of your installation, just make a copy of this volume.

Contributing to OpenRemote

For information and how to set up a development environment, see the Developer Guide.

We work with Java, Groovy, TypeScript, Gradle, Docker, and a wide range of APIs and protocol implementations.

We follow the Github Flow workflow with tags and releases for published versions of our components; when working on the codebase create descriptive branch names (e.g. feature/cool_feature_x, hotfix/flux_capacitor, issue/123, etc.).

When your changes are complete then create a Pull Request ensuring that your branch is up-to-date with the source branch and that code changes are covered by tests and that the full test suite passes.

Discuss OpenRemote

Join us on the community forum.

sorcnr/openremote