This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will make its way to the official docs. You may reply for the specific purpose of improving the article are allowed, but please, this is NOT a support thread: if you’re stuck while reading this and are simply seeking support please open another thread. Thanks!
This tutorial has transitioned to the official docs. Please see Getting Started - First Steps | openHAB.
Create the Admin User
Once installed and started, launch openHAB’s user interface by navigating to http://localhost:8080 (if not running locally, replace localhost with the server’s address or hostname accordingly). If you installed from the openHABian image, you can use http://openhab:8080
The following screen should appear:
By default, the administration pages can only be accessed if you are logged in with an administrator account.
Click on the shield icon in the lower-left corner of the sidebar:
If you don’t see it, click on the menu icon located at the top-left corner to reveal the sidebar.
Since there are no users yet, openHAB will ask you to create an administrator account.
Currently the only way to add additional users or manage existing ones (including changing passwords and attributing roles) is with the Console.
[RLK NOTE: The console docs need to be updated with the commands for managing users]
Once you have successfully created the admin account, you will be taken back to the previous screen, except the Administration area will now be accessible in the sidebar:
If you need to sign out, or check what sessions are open with this account with the option to terminate them, click on the account option which has replaced the “Unlock administration” shield:
Note that by default, using openHAB doesn’t require you to sign in, only administrative operations require a user with an administrator role to be logged in.
Click on Settings.
Click on Regional Settings under System Services.
Configure the local language, region and time zone. You can also specify the exact location (latitude, longitude, altitude) of your home, which some add-ons can use to preset their configuration - for instance the Astro binding will use the location to determine the time of astrological events, like sunrise and sunset in your area.
If you’re not using the metric system, click “Show advanced” and change the measurement system.
The following settings are available but not covered by this tutorial.
[RLK TODO: Add links to the docs for these settings where available]
|Network Settings||Configure the default networks OH listens on and broadcasts on, IPV6, etc.|
|Audio||Configure the default microphone and audio destination|
|Ephemeris||Configure day types (e.g. which days of the week are weekends and import your locale’s holidays), can be used in rules|
|API Security||Allows Basic Auth to be used for accessing protected parts of the openHAB API. Otherwise an authorization token or OAuth2 is required.|
|Addon Management||Whether to download add-ons when they are installed or use a locally installed collection of all the add-ons.|
|Persistence||Set the system wide default persistence engine.|
|Json Storage||Settings for the automatic backup of openHAB’s configuration created thriough the UI (Items, Things, Rules, Pages, etc.).|
|Inbox||Settings that affect how Items are shown and approved in the Inbox where discovered Things appear.|
|Charts||Default settings for generated charts.|
|Voice||Settings for voice-to-text, text-to-voice and human language processing.|
|Other Services||The items that appear here will changed based on the set of add-ons installed. These are places to configure those bindings and capabilities (e.g. set up the connection for InfluxDB Persistence).|