Need help with openremote?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

openremote
320 Stars 67 Forks Other 3.3K Commits 119 Opened issues

Description

100% open-source IoT Platform - Integrate your assets, create rules, and visualize your data

Services available

!
?

Need anything else?

Contributors list

OpenRemote v3

CI/CD Open Source? Yes! <!-- tests -->

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:

Architecture 3.0

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). 1. Make sure you have Docker Desktop installed (v18+). 2. Download the docker compose file: OpenRemote Stack (Right click 'Save link as...') 3. In a terminal
cd
to where you just saved the compose file and then run:
`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

Not using localhost?

The URL you use to access the system is important, by default keycloak expects it to be

https://localhost
if you are using a VM then you will need to tell keycloak at startup, so if for example you will be accessing using
https://192.168.1.1
then use the following startup command:

BASH:

KEYCLOAK_FRONTEND_URL=https://192.168.1.1/auth docker-compose -p openremote up -d
or

CMD:

cmd /C "set KEYCLOAK_FRONTEND_URL=https://192.168.1.1/auth && docker-compose -p openremote up -d"

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:

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

We work with Java, Groovy, TypeScript, Gradle, Docker, and a wide range of APIs and protocol implementations. Clone or checkout this project and send us pull requests, ensure that code is covered by tests and that the full test suite passes.

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

Discuss OpenRemote

Join us on the community forum.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.