OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updates to console.md (#1392) 

Replace example output with 3.0.0 output and other minor fixes.

Signed-off-by: Bob Adair <bob.github@att.net>
pull/1396/head
Bob A 2020-12-28 03:16:12 -05:00 committed by GitHub
parent 553d3eb0a3
commit c04e3d743c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
administration/console.md
View File

@ -7,7 +7,7 @@ title: The Console
# The Console # The Console
The console offers the option to: The console offers the ability to:
* Monitor the [log](logging.html#karaf-console) in realtime * Monitor the [log](logging.html#karaf-console) in realtime
* Manage [bundles](bundles.html) * Manage [bundles](bundles.html)
@ -15,7 +15,7 @@ The console offers the option to:
## Accessing the Console ## Accessing the Console
The method to access the console depends on how openHAB was started. The method used to access the console depends on how openHAB was started.
* When started in interactive mode using the provided command line scripts (e.g. `start.sh` or `start.bat`), openHAB naturally transitions directly to the console prompt. * When started in interactive mode using the provided command line scripts (e.g. `start.sh` or `start.bat`), openHAB naturally transitions directly to the console prompt.
* When started as a service (i.e. when openHAB is running as a background process), access to the console is given by running the `$OPENHAB_RUNTIME/bin/client` (`client.bat` for Windows) script or by [connecting via SSH](#connecting-via-ssh). * When started as a service (i.e. when openHAB is running as a background process), access to the console is given by running the `$OPENHAB_RUNTIME/bin/client` (`client.bat` for Windows) script or by [connecting via SSH](#connecting-via-ssh).
@ -25,7 +25,7 @@ The default username/password is **openhab:habopen**, so enter `habopen` at the
### Connecting via SSH ### Connecting via SSH
The console can also be reached via secure shell connection ([SSH](https://en.wikipedia.org/wiki/Secure_Shell)). The console can also be reached via a secure shell ([SSH](https://en.wikipedia.org/wiki/Secure_Shell)) connection.
To reach the console using SSH, use the following command to connect to the localhost interface on TCP port 8101: To reach the console using SSH, use the following command to connect to the localhost interface on TCP port 8101:
@ -34,7 +34,7 @@ ssh -p 8101 openhab@localhost
``` ```
::: tip Note ::: tip Note
By default, connection is only allowed from localhost, i.e. only from the machine running openHAB. By default, connections are only allowed from localhost, i.e. only from the machine running openHAB.
Connections are intentionally not allowed from remote hosts due to security concerns. Connections are intentionally not allowed from remote hosts due to security concerns.
To change this, see [Bind Console to All Interfaces](#bind-console-to-all-interfaces). To change this, see [Bind Console to All Interfaces](#bind-console-to-all-interfaces).
::: :::
@ -69,17 +69,16 @@ If this happens, simply try connecting again until successful.
After successful connection and authentication, the console will appear: After successful connection and authentication, the console will appear:
```text ```text
__ _____ ____ _ _ _ ____
____ ____ ___ ____ / / / / | / __ ) ___ ___ ___ ___ | | | | / \ | __ )
/ __ \/ __ \/ _ \/ __ \/ /_/ / /| | / __ | / _ \ / _ \ / _ \ / _ \ | |_| | / _ \ | _ \
/ /_/ / /_/ / __/ / / / __ / ___ |/ /_/ / | (_) | (_) | __/| | | || _ | / ___ \ | |_) )
\____/ .___/\___/_/ /_/_/ /_/_/ |_/_____/ \___/| __/ \___/|_| |_||_| |_|/_/ \_\|____/
/_/ 2.2.0 |_| 3.0.0 - Release Build
Release Build
Hit '<tab>' for a list of available commands Use '<tab>' for a list of available commands
and '[cmd] --help' for help on a specific command. and '[cmd] --help' for help on a specific command.
Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown openHAB. To exit, use '<ctrl-d>' or 'logout'.
openhab> openhab>
``` ```
@ -112,10 +111,12 @@ Another useful feature is the combination of the `|` (pipe) and `grep` functiona
```text ```text
openhab> bundle:list | grep openHAB openhab> bundle:list | grep openHAB
164 | Active | 90 | 2.0.0.201607210102 | openHAB Core 128 x Active x 80 x 3.0.0 x openHAB Core :: Bundles :: Core
165 | Active | 80 | 2.0.0.201607210102 | openHAB Karaf Integration 129 x Active x 80 x 3.0.0 x openHAB Core :: Bundles :: Audio
195 | Active | 80 | 2.0.0.201607210102 | openHAB 1.x Compatibility Layer 130 x Active x 80 x 3.0.0 x openHAB Core :: Bundles :: JAAS Authentication
196 | Active | 80 | 2.0.0.201607210102 | openHAB REST Documentation 131 x Active x 80 x 3.0.0 x openHAB Core :: Bundles :: OAuth2Client
132 x Active x 80 x 3.0.0 x openHAB Core :: Bundles :: Automation
...
``` ```
The session is ended by using the logout command: The session is ended by using the logout command:
@ -124,7 +125,7 @@ The session is ended by using the logout command:
openhab> logout openhab> logout
``` ```
Learn about all available commands by using the initially introduced `help` command. Learn about all of the available commands by using the `help` command.
## Modifying the Console Settings ## Modifying the Console Settings
@ -167,10 +168,10 @@ As this file may get overwritten when upgrading openHAB, you can change this par
The `sshHost` entry controls the interface address to bind to. The `sshHost` entry controls the interface address to bind to.
`sshHost = 127.0.0.1` (localhost) is the default due to obvious security reasons. `sshHost = 127.0.0.1` (localhost) is the default due to obvious security reasons.
If you are on a local network or you are fully aware of all risks of exposing your system to the public, you can change the bind address. If you are on a secure network or you are fully aware of all of the risks of exposing your system to the public, you can change the bind address.
Replace the `sshHost` IP `127.0.0.1` by `0.0.0.0` to bind to all available network interfaces. Replace the `sshHost` IP `127.0.0.1` by `0.0.0.0` to bind to all available network interfaces.
Please be aware, that the console will now be accessible from all devices in your subnet and is only secured by the password defined in `users.properties` (same path). Please be aware that the console will now be accessible from all devices in your subnet and only secured by the password defined in `users.properties` (same path).
You should thereby [change the password](#changing-the-password). You should therefore [change the password](#changing-the-password)!
Depending on your network configuration the console may also be exposed to the public internet, so check your routing and firewall configuration. Depending on your network configuration the console may also be exposed to the public internet, so check your routing and firewall configuration.
To enable binding to all interfaces, uncomment the line To enable binding to all interfaces, uncomment the line
@ -184,7 +185,7 @@ in `services/runtime.cfg`.
The SSH port configuration is done through the file `org.apache.karaf.shell.cfg`, located in the `etc` directory as [mentioned above](#console-settings-files-and-directories). The SSH port configuration is done through the file `org.apache.karaf.shell.cfg`, located in the `etc` directory as [mentioned above](#console-settings-files-and-directories).
The `sshPort` entry controls the port number. The `sshPort` entry controls the port number.
`sshPort = 8101` is the default, but can be changed to any available port per your choosing. `sshPort = 8101` is the default, but can be changed to any available port of your choosing.
Alternately, run the following Linux shell command, which will perform the replacement for you. Alternately, run the following Linux shell command, which will perform the replacement for you.
Substitute `1234` with your desired port number. Substitute `1234` with your desired port number.