136 lines
4.5 KiB
Markdown
136 lines
4.5 KiB
Markdown
---
|
|
layout: documentation
|
|
title: Mac OS X
|
|
---
|
|
|
|
{% include base.html %}
|
|
|
|
# Installation on Mac OS X
|
|
|
|
This page is structured as follows:
|
|
|
|
{::options toc_levels="2..4"/}
|
|
|
|
- TOC
|
|
{:toc}
|
|
|
|
If you're unfamiliar with using the Mac OS terminal, then feel free to follow the many guides on the internet. For example:
|
|
|
|
[Macworld: How to use Terminal on mac](http://www.macworld.co.uk/feature/mac-software/how-use-terminal-on-mac-3608274/)
|
|
|
|
## Installation
|
|
|
|
openHAB is packaged as a platform independent `zip` archive. Installation is as simple as unziping it into a unique folder.
|
|
First, make sure that your system meets the [prerequisites](index.html#prerequisites).
|
|
|
|
You have the choice to use the current stable version or the latest snapshot build:
|
|
|
|
- **Stable**
|
|
|
|
The stable builds have undergone testing, it is the recommended version to download.
|
|
Download the latest `openhab-2.x.x.zip` [here](https://bintray.com/openhab/mvn/openhab-distro/_latestVersion).
|
|
|
|
- **Snapshot (Unstable)**
|
|
|
|
Snapshots are built daily, and contain the latest changes to openHAB's source code.
|
|
These changes haven't undergone the same amount of testing as the stable releases, so only use them if you **need** a new feature.
|
|
Download the latest `openhab-2.x.x-SNAPSHOT.zip` [here](https://openhab.ci.cloudbees.com/job/openHAB-Distribution).
|
|
|
|
The following instructions are performed in a terminal window. At first launch of the terminal, you will be inside your home directory.
|
|
|
|
Choose a folder name to host your install. Be aware that the path to this folder **must not contain any spaces**.
|
|
The path chosen here is `openhab`.
|
|
|
|
```shell
|
|
mkdir ~/openhab
|
|
cd ~/openhab
|
|
```
|
|
|
|
Next, unzip the file downloaded earlier.
|
|
Assuming that you have downloaded the **stable** build to your download folder, the command will be:
|
|
|
|
```shell
|
|
unzip ~/Downloads/openhab-2.x.x.zip -d .
|
|
```
|
|
|
|
Check that the zip extraction was successful by using the `ls` command in order to check the contents of the folder.
|
|
|
|
```shell
|
|
user:openhab $ ls
|
|
LICENSE.TXT conf start.bat start_debug.bat userdata
|
|
addons runtime start.sh start_debug.sh
|
|
```
|
|
|
|
If you see something similar to the above, then you're all set to launch openHAB for the first time.
|
|
|
|
## Launching openHAB
|
|
|
|
From inside openHAB's root directory (e.g. `~/openhab/), run openHAB's startup script by using the following command.
|
|
|
|
```shell
|
|
./start.sh
|
|
```
|
|
|
|
The first run may take a while to process, wait until the "`openhab>`" prompt appears, for example:
|
|
|
|
```shell_session
|
|
user:openhab $ sudo ./start.sh
|
|
Launching the openHAB runtime...
|
|
|
|
__ _____ ____
|
|
____ ____ ___ ____ / / / / | / __ )
|
|
/ __ \/ __ \/ _ \/ __ \/ /_/ / /| | / __ |
|
|
/ /_/ / /_/ / __/ / / / __ / ___ |/ /_/ /
|
|
\____/ .___/\___/_/ /_/_/ /_/_/ |_/_____/
|
|
/_/ 2.0.0 ...
|
|
|
|
|
|
Hit '<tab>' for a list of available commands
|
|
and '[cmd] --help' for help on a specific command.
|
|
Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown openHAB.
|
|
|
|
openhab>
|
|
```
|
|
|
|
Without closing the terminal, open your favorite web browser and type the following URL: [http://localhost:8080](http://localhost:8080), you should see the openHAB welcome screen, and you're all set to [using openHAB]({{base}}/tutorials/beginner/1sttimesetup.html).
|
|
|
|
|
|
|
|
## Updating openHAB
|
|
|
|
openHAB can use a script to update to any other version, or from stable to snapshot and visa-versa.
|
|
|
|
### Versions 2.1.0 and Above
|
|
|
|
From version 2.1.0, openHAB is distributed with the update script included.
|
|
This script should be called from within openHAB's root directory.
|
|
Assuming the openHAB directory is in `~/openhab`, simply run the following commands to update to the next major version of openHAB:
|
|
|
|
```shell
|
|
cd ~/openhab
|
|
sudo runtime/bin/update
|
|
```
|
|
|
|
You can also specify any version as a parameter. For example, to switch back to 2.0.0:
|
|
|
|
```shell
|
|
sudo runtime/bin/update 2.0.0
|
|
```
|
|
|
|
You may also change to openHAB's more frequent, but less stable snapshot builds.
|
|
Just append "-SNAPSHOT" to the target version, e.g.:
|
|
|
|
```shell
|
|
sudo runtime/bin/update 2.2.0-SNAPSHOT
|
|
```
|
|
|
|
### Older Versions
|
|
|
|
If you're using a version earlier than 2.1.0, then you can use the following commands in Terminal to download the script and run it.
|
|
Assuming the openHAB directory is in `~/openhab` simply run the following commands to update to the next major version of openHAB:
|
|
|
|
```shell
|
|
cd ~/openhab
|
|
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/openhab/openhab-distro/master/distributions/openhab/src/main/resources/bin/update)" -- 2.1.0
|
|
```
|