PageSourceSearch

https://docs.openremote.io/docs/quick-start/

html openremote.io collected 2026-10-02 04:21:32 UTC 36,387 bytes, 51 lines download raw bytes

1<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-1.31.0 docs-doc-page docs-doc-id-quick-start" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.2"><title data-rh=true>Quick Start | OpenRemote Documentation</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://docs.openremote.io/img/openremote-social-card.svg /><meta data-rh=true name=twitter:image content=https://docs.openremote.io/img/openremote-social-card.svg /><meta data-rh=true property=og:url content=https://docs.openremote.io/docs/quick-start /><meta data-rh=true property=og:locale content=en /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=docusaurus_version content=1.31.0 /><meta data-rh=true name=docusaurus_tag content=docs-default-1.31.0 /><meta data-rh=true name=docsearch:version content=1.31.0 /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-1.31.0 /><meta data-rh=true property=og:title content="Quick Start | OpenRemote Documentation"/><meta data-rh=true name=description content="Welcome to OpenRemote; an intuitive user-friendly 100% open source IoT platform. You can build a complete IoT device management solution including: device management and auto provisioning, customisation of asset types, automation via When-Then, Flow and Groovy rules, data analytics, c
1onnectivity via several protocol agents and manager APIs (e.g. MQTT broker, HTTP/REST, WS), Multi-tenancy (realms), Users and roles management, Edge gateway, Front-end UI web components and consoles, and an Insights dashboard builder."/><meta data-rh=true property=og:description content="Welcome to OpenRemote; an intuitive user-friendly 100% open source IoT platform. You can build a complete IoT device management solution including: device management and auto provisioning, customisation of asset types, automation via When-Then, Flow and Groovy rules, data analytics, connectivity via several protocol agents and manager APIs (e.g. MQTT broker, HTTP/REST, WS), Multi-tenancy (realms), Users and roles management, Edge gateway, Front-end UI web components and consoles, and an Insights dashboard builder."/><link data-rh=true rel=icon href=/img/favicon.ico /><link data-rh=true rel=canonical href=https://docs.openremote.io/docs/quick-start /><link data-rh=true rel=alternate href=https://docs.openremote.io/docs/quick-start hreflang=en /><link data-rh=true rel=alternate href=https://docs.openremote.io/docs/quick-start hreflang=x-default /><link data-rh=true rel=preconnect href=https://TVHZ0YEM1U-dsn.algolia.net crossorigin=anonymous />
1<script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openremote.io/docs/quick-start","name":"Quick Start","position":1}]}</script>
1<link rel=preconnect href=https://www.google-analytics.com><link rel=preconnect href=https://www.googletagmanager.com>
1<script async src="https://www.googletagmanager.com/gtag/js?id=GTM-MWP6C7F"></script>
1<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","GTM-MWP6C7F",{})</script>
1<link rel=search type=application/opensearchdescription+xml title="OpenRemote Documentation" href=/opensearch.xml><link rel=stylesheet href=/assets/css/styles.3585d622.css />
1<script src=/assets/js/runtime~main.ffe44db4.js defer></script>
1<script src=/assets/js/main.3ab150a0.js defer></script>
1</head><body><svg style="display: none;"><defs>
2<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
3</defs></svg>
4<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script>
4<div id=__docusaurus><link rel=preload as=image href=/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/logo.svg alt="OpenRemote Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/logo.svg alt="OpenRemote Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div><b class="navbar__title text--truncate">OpenRemote</b></a><div class="navbar__item dropdown dropdown--hoverable"><a aria-current=page class="navbar__link active" aria-haspopup=true aria-expanded=false role=button href=/docs/quick-start>1.31.0</a><ul class=dropdown__menu><li><a class=dropdown__link href=/docs/next/quick-start>Next</a><li><a aria-current=page class="dropdown__link dropdown__link--active" href=/docs/quick-start>1.31.0</a><li><a class=dropdown__link href=/docs/1.30.0/quick-start>1.30.0</a><li><a class=dropdown__link href=/docs/1.29.0/quick-start>1.29.0</a><li><a class=dropdown__link href=/docs/1.28.0/quick-start>1.28.0</a><li><a class=dropdown__link href=/docs/1.27.0/quick-start>1.27.0</a><li><a class=dropdown__link href=/docs/1.26.0/quick-start>1.26.0</a><li><a class=dropdown__link href=/docs/1.25.0/quick-start>1.25.0</a><li><a class=dropdown__link href=/docs/1.24.0/quick-start>1.24.0</a><li><a class=dropdown__link href=/docs/1.23.0/quick-start>1.23.0</a><li><a class=dropdown__link href=/docs/1.22.0/quick-start>1.22.0</a><li><a class=dropdown__link href=/docs/1.21.0/quick-start>1.21.0</a><li><a class=dropdown__link href=/docs/1.20.0/quick-start>1.20.0</a><li><a class=dropdown__link href=/docs/1.19.0/quick-start>1.19.0</a><li><a class=dropdown__link href=/docs/1.18.0/quick-start>1.18.0</a></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href=https://forum.openremote.io/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Forum<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><a href=https://github.com/openremote/openremote target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><a href=https://www.openremote.io/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Website<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_
4wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1><button type=button class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts=Meta+k><span class=DocSearch-Button-Container><svg width=20 height=20 class=DocSearch-Search-Icon viewBox="0 0 24 24" aria-hidden=true><circle cx=11 cy=11 r=8 stroke=currentColor fill=none stroke-width=1.4 /><path d="m21 21-4.3-4.3" stroke=currentColor fill=none stroke-linecap=round stroke-linejoin=round /></svg><span class=DocSearch-Button-Placeholder>Search</span></span><span class=DocSearch-Button-Keys></span></button></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/introduction><span class=linkLabel_WmDU>Introduction</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current=page href=/docs/quick-start><span class=linkLabel_WmDU>Quick Start</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/user-guide><span class=categoryLinkLabel_W154>User Guide</span></a><button aria-label="Collapse sidebar category 'User Guide'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/deploying><span class=categoryLinkLabel_W154>Deploying</span></a><button aria-label="Expand sidebar category 'Deploying'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/manager-ui><span class=categoryLinkLabel_W154>Manager UI</span></a><button aria-label="Expand sidebar category 'Manager UI'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/docs/user-guide/assets-agents-and-attributes><span class=linkLabel_WmDU>Assets, Agents and Attributes</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/agentsprotocols><span class=categoryLinkLabel_W154>Agents/Protocols</span></a><button aria-label="Expand sidebar category 'Agents/Protocols'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/docs/user-guide/manager-apis><span class=linkLabel_WmDU>Manager APIs</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/rules-and-forecasting><span class=categoryLinkLabel_W154>Rules and Forecasting</span></a><button aria-label="Expand sidebar category 'Rules and Forecasting'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/identity-and-security><span class=categoryLinkLabel_W154>Identity and Security</span></a><button aria-label="Expand sidebar category 'Identity and Security'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/gateways-and-devices><span class=categoryLinkLabel_W154>Gateways and Devices</span></a><button aria-label="Expand sidebar category 'Gateways and Devices'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/domains><span class=categoryLinkLabel_W154>Domains</span></a><button aria-label="Expand sidebar category 'Domains'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/services><span class=categoryLinkLabel_W154>Services</span></a><button aria-label="Expand sidebar category 'Services'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/docs/category/observability><span class=categoryLinkLabel_W154>Observability</span></a><button aria-label="Expand sidebar category 'Observability'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/docs/user-guide/ai-mcp-server><span class=linkLabel_WmDU>AI Integration (MCP Server)</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/tutorials><span class=categoryLinkLabel_W154>Tutorials</span></a><button aria-label="Expand sidebar category 'Tutorials'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/developer-guide><span class=categoryLinkLabel_W154>Developer Guide</span></a><button aria-label="Expand sidebar category 'Developer Guide'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/architecture><span class=categoryLinkLabel_W154>Architecture</span></a><button aria-label="Expand sidebar category 'Architecture'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/rest-api><span class=categoryLinkLabel_W154>REST API</span></a><button aria-label="Expand sidebar category 'REST API'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a href=https://www.javadoc.io/doc/io.openremote target=_blank rel="noopener noreferrer" class="menu__link menuExternalLink_NmtK"><span class=linkLabel_WmDU>JavaDoc</span><svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_xLCN"><div class=docItemContainer_jfFK><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Quick Start</span></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.31.0</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><div class=row><div class="col col--12 markdown"><header><h1>Quick Start</h1></header>
5<p>Welcome to OpenRemote;
5 an intuitive user-friendly 100% open source IoT platform. You can build a complete IoT device management solution including: device management and auto provisioning, customisation of asset types, automation via When-Then, Flow and Groovy rules, data analytics, connectivity via several protocol agents and manager APIs (e.g. MQTT broker, HTTP/REST, WS), Multi-tenancy (realms), Users and roles management, Edge gateway, Front-end UI web components and consoles, and an Insights dashboard builder.</p>
6<p>As the code base is 100% open source, applications are limitless. Here's an architecture overview:</p>
7<p><img decoding=async loading=lazy alt=image src=/assets/images/architecture-32e43028000b886c4d7a6e76aeba65cb.jpg width=2560 height=1638 class=img_ev3q /></p>
8<p>You can quickly try the online demo with restricted access, login credentials are <code>smartcity:smartcity</code>:</p>
9<p><a href="https://demo.openremote.app/manager/?realm=smartcity" target=_blank rel="noopener noreferrer" class="">Online demo</a></p>
10<p>The quickest way to get your own environment with full access is to make use of our Docker images (both <code>amd64</code> and <code>arm64</code> are supported).</p>
11<ol>
12<li class="">Make sure you have <a href=https://www.docker.com/products/docker-desktop target=_blank rel="noopener noreferrer" class="">Docker Desktop</a> installed (v18+).</li>
13<li class="">Download the Docker Compose file:
14<a href=https://raw.githubusercontent.com/openremote/openremote/master/docker-compose.yml target=_blank rel="noopener noreferrer" class="">OpenRemote Stack</a> (Right click 'Save link as...')</li>
15<li class="">In a terminal <code>cd</code> to where you just saved the compose file and then run:</li>
16</ol>
17<div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#bfc7d5;--prism-background-color:#292d3e><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style=color:#bfc7d5;background-color:#292d3e><code class=codeBlockLines_e6Vv><div class=token-line style=color:#bfc7d5><span class="token function" style="color:rgb(130, 170, 255)">docker-compose</span><span class="token plain"> pull</span><br/></div><div class=token-line style=color:#bfc7d5><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">docker-compose</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-p</span><span class="token plain"> openremote up</span><br/></div></code></pre></div></div>
18<p>If all goes well then you should now be able to access the OpenRemote Manager UI at <a href=https://localhost target=_blank rel="noopener noreferrer" class="">https://localhost</a>. You will need to accept the self-signed
19certificate, see <a href=https://www.technipages.com/google-chrome-bypass-your-connection-is-not-private-message target=_blank rel="noopener noreferrer" class="">here</a> for details how to do this in Chrome (similar for other browsers).</p>
20<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=login-credentials>Login credentials<a href=#login-credentials class=hash-link aria-label="Direct link to Login credentials" title="Direct link to Login credentials" translate=no>​</a></h3>
21<p>Username: admin
22Password: secret</p>
23<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=changing-host>Changing host<a href=#changing-host class=hash-link aria-label="Direct link to Changing host" title="Direct link to Changing host" translate=no>​</a></h3>
24<p>The URL you use to access the system is important, the default is configured as <code>https://localhost</code> if you are using a VM then you will need to set the <code>OR_HOSTNAME</code> environment variable, so if for example you will be accessing using <code>https://192.168.1.1</code> then use the following startup command:</p>
25<p>BASH:</p>
26<div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#bfc7d5;--prism-background-color:#292d3e><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style=color:#bfc7d5;background-color:#292d3e><code class=codeBlockLines_e6Vv><div class=token-line style=color:#bfc7d5><span class="token assign-left variable" style="color:rgb(191, 199, 213)">OR_HOSTNAME</span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token number" style="color:rgb(247, 140, 108)">192.168</span><span class="token plain">.1.1 </span><span class="token function" style="color:rgb(130, 170, 255)">docker-compose</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-p</span><span class="token plain"> openremote up </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-d</span><br/></div></code></pre></div></div>
27<p>or</p>
28<p>CMD:</p>
29<div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#bfc7d5;--prism-background-color:#292d3e><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style=color:#bfc7d5;background-color:#292d3e><code class=codeBlockLines_e6Vv><div class=token-line style=color:#bfc7d5><span class="token plain">cmd /C </span><span class="token string" style="color:rgb(195, 232, 141)">"set OR_HOSTNAME=192.168.1.1 && docker-compose -p openremote up -d"</span><br/></div></code></pre></div></div>
30<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=what-next>What next<a href=#what-next class=hash-link aria-label="Direct link to What next" title="Direct link to What next" translate=no>​</a></h2>
31<p>Try creating assets, agents, rules, users, realms, etc. using the Manager UI, some things to try:</p>
32<ul>
33<li class=""><a class="" href=/docs/user-guide/manager-ui/>
33Manager UI Guide</a> - Learn more about the User Interface</li>
34<li class=""><a class="" href=/docs/tutorials/open-weather-api-using-http-agent>Creating an HTTP Agent tutorial</a> - Connect to an online weather service</li>
35<li class=""><a class="" href=/docs/user-guide/deploying/custom-deployment>Custom Deployment</a> - Style the Manager to your brand</li>
36<li class=""><a class="" href=/docs/developer-guide/setting-up-an-ide>Setting up an IDE</a> - Set up your development environment</li>
37<li class=""><a class="" href=/docs/developer-guide/working-on-ui-and-apps>Working on the UI</a> - Create a web application compatible with OpenRemote</li>
38<li class=""><a class="" href=/docs/developer-guide/creating-a-custom-project>Creating a custom project</a> - Create a project with custom protocols, asset types and setup code</li>
39</ul>
40<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=wheres-the-data-stored>Where's the data stored?<a href=#wheres-the-data-stored class=hash-link aria-label="Direct link to Where's the data stored?" title="Direct link to Where's the data stored?" translate=no>​</a></h2>
41<p>Persistent data is stored in a PostgreSQL DB which is stored in the <code>openremote_postgresql-data</code> Docker volume which is durably stored independently of the running containers (see all with <code>docker volume ls</code>).
42Note that historical attribute data is purged daily based on value of <code>OR_DATA_POINTS_MAX_AGE_DAYS</code>; this value can also be overridden for individual attributes by using the <code>dataPointsMaxAgeDays</code> configuration item.
43See the <a class="" href=/docs/developer-guide/system-administration#backuprestore>Developer Guide</a> for details on making backups of the database.</p>
44<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=contributing-to-openremote>Contributing to OpenRemote<a href=#contributing-to-openremote class=hash-link aria-label="Direct link to Contributing to OpenRemote" title="Direct link to Contributing to OpenRemote" translate=no>​</a></h2>
45<p>For information and how to set up a development environment, see the <a class="" href=/docs/developer-guide/preparing-the-environment>Developer Guide</a>.</p>
46<p>We work with Java, Groovy, TypeScript, Gradle, Docker, and a wide range of APIs and protocol implementations.</p>
47<p>We follow the <a href=https://docs.github.com/en/get-started/quickstart/github-flow target=_blank rel="noopener noreferrer" class="">GitHub Flow</a> workflow with tags and releases for published versions of our components; when working on the codebase create descriptive branch names (e.g. <code>feature/cool_feature_x</code>, <code>hotfix/flux_capacitor</code>, <code>issue/123</code>, etc.).</p>
48<p>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.</p>
49<p>Before opening the pull request, <a class="" href=/docs/developer-guide/code-formatting>check and apply the repository's code-formatting rules</a>.</p>
50<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=discuss-openremote>Discuss OpenRemote<a href=#discuss-openremote class=hash-link aria-label="Direct link to Discuss OpenRemote" title="Direct link to Discuss OpenRemote" translate=no>​</a></h2>
51<p>Join us on the <a href=https://forum.openremote.io/ target=_blank rel="noopener noreferrer" class="">community forum</a>.</div></div></div><div class=row><div class="col col--12"><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href=https://github.com/openremote/documentation/edit/main/docs/20-quick-start.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></div></div></article><div class=row><div class="col col--12"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/docs/introduction><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/docs/category/user-guide><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>User Guide</div></a></nav></div></div></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#login-credentials class="table-of-contents__link toc-highlight">Login credentials</a><li><a href=#changing-host class="table-of-contents__link toc-highlight">Changing host</a><li><a href=#what-next class="table-of-contents__link toc-highlight">What next</a><li><a href=#wheres-the-data-stored class="table-of-contents__link toc-highlight">Where's the data stored?</a><li>
51<a href=#contributing-to-openremote class="table-of-contents__link toc-highlight">Contributing to OpenRemote</a><li><a href=#discuss-openremote class="table-of-contents__link toc-highlight">Discuss OpenRemote</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/docs/introduction>Documentation</a><li class=footer__item><a class=footer__link-item href=/docs/quick-start>Quick Start</a><li class=footer__item><a class=footer__link-item href=/docs/category/rest-api>REST API</a><li class=footer__item><a href=https://www.javadoc.io/doc/io.openremote target=_blank rel="noopener noreferrer" class=footer__link-item>JavaDoc<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://forum.openremote.io/ target=_blank rel="noopener noreferrer" class=footer__link-item>Forum<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.facebook.com/openremote target=_blank rel="noopener noreferrer" class=footer__link-item>Facebook<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.instagram.com/openremote/ target=_blank rel="noopener noreferrer" class=footer__link-item>Instagram<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.linkedin.com/company/openremote/ target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.reddit.com/r/openremote/ target=_blank rel="noopener noreferrer" class=footer__link-item>Reddit<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://x.com/OpenRemotePro/ target=_blank rel="noopener noreferrer" class=footer__link-item>X<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.youtube.com/c/openremotepro target=_blank rel="noopener noreferrer" class=footer__link-item>YouTube<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.openremote.io/ target=_blank rel="noopener noreferrer" class=footer__link-item>Website</a><li class=footer__item><a href=https://www.openremote.io/news/ target=_blank rel="noopener noreferrer" class=footer__link-item>News</a><li class=footer__item><a href=https://www.openremote.io/demo/ target=_blank rel="noopener noreferrer" class=footer__link-item>Demo<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://github.com/openremote/openremote/ target=_blank rel="noopener noreferrer" class=footer__link-item>Source Code<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item>
51<a href=https://openremote.io/open-source/ target=_blank rel="noopener noreferrer" class=footer__link-item>OSS Licensing<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://www.openremote.io/contact/ target=_blank rel="noopener noreferrer" class=footer__link-item>Contact<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://openremote.io/privacy-policy/ target=_blank rel="noopener noreferrer" class=footer__link-item>Privacy Policy<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>© 2026 OpenRemote, Inc. All Rights Reserved.</div></div></div></footer></div></body>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.