Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Edits to Installation index.md file #1335

Merged
merged 3 commits into from
Dec 19, 2020
Merged

Edits to Installation index.md file #1335

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb7fb38
Edits to installation index.md file
bobadair Dec 19, 2020
8f5f725
Update index.md
bobadair Dec 19, 2020
1311212
Update index.md
bobadair Dec 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ title: Installation Overview

# Installation Overview

openHAB is fully written in Java.
As such, it only depends on a Java Virtual Machine, which is available for many platforms.
openHAB can be executed on different versions of **macOS** and **Windows** and many different variants of **Linux** (Ubuntu, Raspbian, ...).
openHAB is written completely in Java.
As such, it only depends on a Java Virtual Machine, which is available for most platforms.
openHAB can be run on different versions of **macOS** and **Windows** and many different variants of **Linux** (Ubuntu, Raspbian, etc.).

Please be aware of the fact, that openHAB is continously improved and changed.
Therefore, tutorials and help you may find on the internet for **might** be outdated!
Always keep this in mind, when searching for help and solutions.
Please be aware of the fact that openHAB is continuously updated and improved.
Therefore, tutorials and help you may find on the Internet for it **may** be outdated!
Always keep this in mind when searching for help and solutions.

## Platform Recommendations

1. You are **new to openHAB** and want to give it a try? You are in luck:
- Set up openHAB on your local PC or Mac in just a few steps.

1. You gained some experience and want to use openHAB to seriously control your home?
1. You've gained some experience and want to use openHAB to seriously control your home?
Typical hardware and software requirements are:
- **24/7 availability:** A dedicated system connected by Ethernet and running continuously.
- **Energy and space efficient:** A device capable of performing the task at hand without being exaggerated
- **Extendibility:** Your system should be capable of running additional software like an MQTT broker or a persistence and graphing software.
- **Peripherals:** Depending on your home automation hardware, you will need additional peripheral devices such as a WiFi interface or a special USB radio module.
- **Energy and space efficient:** A device capable of performing the task at hand without being excessive for your needs.
- **Extendibility:** Your system should be capable of running additional software like an MQTT broker or persistence and graphing software.
- **Peripherals:** Depending on your home automation hardware, you may need the ability to connect additional peripheral devices such as a WiFi interface or a special USB radio module.

Many devices are suited to host a continuous installation of openHAB.
Experiences with different devices and environments can be found in the [community forum hardware section](https://community.openhab.org/c/hardware/server).
Expand All @@ -38,14 +38,14 @@ Please check the menu to the left for all available options.

## Prerequisites

Make sure that you have an up to date **Java 11** platform installed on your host system.
Make sure that you have an up to date **Java 11** JVM platform installed on your host system.
Zulu is currently the recommended Java platform for openHAB.
[Download](https://www.azul.com/downloads/zulu-community/?&architecture=x86-64-bit&package=jdk#) and [installation](https://docs.azul.com/zulu/zuludocs/ZuluUserGuide/InstallingZulu/InstallationWindowsUsingZuluMSIFile.htm) instructions can be found on Azul Systems' Zulu website.
Oracle Java is also suitable for most configurations but licensing restrictions may apply.
Oracle Java is also suitable for most configurations, but licensing restrictions may apply.
OpenJDK may also be used, but it has some [known limitations](https://community.openhab.org/t/running-openhab-2-on-openjdk/21443/8?u=gatekeeper6838) with openHAB and is not recommended.

::: warning
Please note that higher versions than Java 11 are also not supported at the moment.
Please note that versions of Java higher than 11 are not supported at the moment.
:::

| Java Platform | Advantages | Disadvantages |
Expand All @@ -55,7 +55,7 @@ Please note that higher versions than Java 11 are also not supported at the mome
| [AdoptOpenJDK](https://adoptopenjdk.net) | Open Source JDK backed by many large companies | |

Please download and install the **Java 11** version of the JVM.
openHAB 3 will use Java 11 and you *can* go for it with 2.X, too, but be aware that although developers are working hard to make this work, there might be problems with the oldest parts of openHAB such as some of the v1 bindings due to non-backward compatible changes in Java 11.
Note that openHAB 3 will run under Java 11, and you *can* use it with openHAB 2.X as well. But be aware that although developers are working hard to make this work, there might be problems with the oldest parts of openHAB 2.x, such as some of the v1 bindings, due to non-backward compatible changes in Java 11.

The **64-bit version** of the JVM is recommended on platforms using a 64-bit OS and an Intel or AMD processor.

Expand All @@ -76,11 +76,11 @@ Before you can start, two decisions have to be made:

1. openHAB is available as a platform independent archive file or through a package repository:
- **Manual setup:** Download and extract a platform independent zip archive: [macOS](macos.html), [Windows](windows.html), [Linux](linux.html#manual-installation)
- **Package setup:** Install through a package repository, including automatic updates.
This option is only available for Debian or Ubuntu derivatives and the recommended choice: [Linux (apt/deb)](linux.html#package-repository-installation)
- **Package setup:** Install from a package repository, using a package manager such as apt or yum.
This option is only available for certain Linux distributions such as Debian or Ubuntu derivatives, but allows you to take advantage of automatic updates and is the recommended choice: [Linux (apt/deb)](linux.html#package-repository-installation)

2. Stable release or cutting edge:
- **Stable:** Use the latest official release ([hosted on Bintray](https://bintray.com/openhab/mvn/openhab-distro)).
- **Stable:** Use the latest official release [hosted on Bintray](https://bintray.com/openhab/mvn/openhab-distro) (recommended for new users).
- **Snapshot:** Benefit from the latest changes in the daily created snapshot ([hosted on openhab.org](https://ci.openhab.org/)).

## Installation
Expand All @@ -89,9 +89,9 @@ Please follow the instructions in the installation article matching your platfor

## Additional Steps

After you got openHAB set up and running, there are a few additional setup steps you should consider:
After you get openHAB set up and running, there are a few additional setup steps you should consider:

- Configure a network share on your openHAB host device and mount it locally: [Linux Samba Share](linux.html#network-sharing), Windows file sharing, ...
- Configure a network share on your openHAB host system using [Linux Samba Share](linux.html#network-sharing) for easier remote editing of configuration files.

- Install [Visual Studio Code](https://code.visualstudio.com/Download) and the [openHAB VS Code Extension]({{base}}/configuration/editors.html#openhab-vs-code-extension) on your local machine, to manage your (remote) configuration files.
The openHAB VS Code Extension comes with built-in support for the openHAB syntax and elements.
Expand All @@ -104,5 +104,5 @@ or by working on your own configuration.

## Help

The very active [openHAB Community Forum](https://community.openhab.org) provides many more details and hints.
If you run into any problems, use the search function or open a new thread with your detailed question.
The very active [openHAB Community Forum](https://community.openhab.org) can provide you with many more details, hints, and tips.
If you run into any problems, use the search function in the forum or open a new thread with your detailed question.