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

Adapt demo and migration tutorial to new package types (#143) 

* adapted demo and migration tutorial to new package types

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* fixed typo

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* fixed another typo

Signed-off-by: Kai Kreuzer <kai@openhab.org>
pull/142/head
Kai Kreuzer 2016-12-03 13:38:27 +01:00 committed by Thomas Dietrich
parent 505fc7b5c9
commit 37198647ac
2 changed files with 14 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tutorials/demo.md
View File

@ -23,7 +23,7 @@ You will find the following folders:
- `userdata`: Here you will find all the data that is generated during runtime: log files, database files, etc. In theory this should be the only folder where openHAB needs write permission on.
- `addons`: Here you can drop add-ons (or any other OSGi bundles) that you want to be deployed in your instance. These can be add-ons for openHAB 1.x and 2.x likewise. Note that all "normal" add-ons are already included in the openHAB distribution and all you need is to name them in your 'addons.cfg' file (see below). Hence the `addons` folder is mainly useful if you have received jars from other sources and want to install and test them.
## Choosing Demo as a Base Package and further add-ons to be Installed
## Choosing Demo as a Base Package and Further Add-ons to be Installed
The demo package consists of example configuration files and samples of add-ons and UIs. In order to install the demo, you must edit the file 'conf/services/addons.cfg'.
Uncomment the line `package=` and set it to `demo` as shown below:
@ -32,16 +32,15 @@ Uncomment the line `package=` and set it to `demo` as shown below:
# The base installation package of this openHAB instance (default is "standard")
# Valid options:
# - minimal : Installation only with dashboard, but no UIs or other addons
# - standard : Typical installation with all standards UIs
# - simple : Setup for using openHAB purely through UIs - you need to expect MANY constraints in functionality!
# - standard : Default setup for normal users, best for textual setup
# - expert : Setup for expert users, especially for people migrating from openHAB 1.x
# - demo : A demo setup which includes UIs, a few bindings, config files etc.
#
package = demo
...
```
_NOTE:_ As long as you have selected the `demo` package in `addons.cfg`, you are not able to uninstall any of the installed addons.
So once you are ready to build your personal setup, don't forget to switch the base package back to `standard`.
## Starting the Runtime
Once you have configured your runtime as above, start the openHAB runtime from the terminal by calling `./start.sh` (`start.bat` on Windows):

23
tutorials/migration.md
View File

@ -158,13 +158,12 @@ Next open for editing `addons.cfg`. This file contains parameters related to
add-ons including allowing one to choose which add-ons to install. For now just
set the following parameters:
- `package = minimal` - minimal or standard are good choices here. Standard
will include the standard UIs, though you can choose those individually later
- `remote = true` - required for the installation of legacy 1.x and
experimental add-ons
- `package = expert` - expert is a good choice here. It will include the standard
UIs, all transformation services and the 1.x compatibility layer,
though you can choose your UIs and add-ons individually later.
- `remote = true` - required for the installation of legacy 1.x add-ons
- `legacy = true` - required to install the 1.9 version of an add-on for which
there is a 2.0 native version
- `experimental = true` - required to install experimental add-ons
- `binding = ` - a comma separated list of the bindings from openHAB 1.x that
you use. If you are in doubt of the name of a binding, look in openhab.cfg for
that binding's configurations. The first part of the tag in openhab.cfg will be
@ -202,10 +201,12 @@ An example addons.cfg:
# The base installation package of this openHAB instance (default is "standard")
# Valid options:
# - minimal : Installation only with dashboard, but no UIs or other addons
# - standard : Typical installation with all standards UIs
# - simple : Setup for using openHAB purely through UIs - you need to expect MANY constraints in functionality!
# - standard : Default setup for normal users, best for textual setup
# - expert : Setup for expert users, especially for people migrating from openHAB 1.x
# - demo : A demo setup which includes UIs, a few bindings, config files etc.
#
#package = standard
package = standard
# Access Remote Add-on Repositories
# Defines whether the remote openHAB add-on repository should be used for browsing and installing add-ons.
@ -214,17 +215,11 @@ An example addons.cfg:
#
remote = true
# Include legacy 1.x bindings. If set to true, it also allows the installation of 1.x bindings for which there is
# Include legacy 1.x bindings. If set to true, it also allows the installation of 1.x bindings for which there is
# already a 2.x version available (requires remote repo access, see above). (default is false)
#
legacy = true
# Include experimental add-ons. If set to true, it also allows the installation of extensions that are not (yet) part
# of the official distribution and need further testing (requires remote repo access, see above). (default is false)
#
experimental = true
# A comma-separated list of bindings to install (e.g. "sonos,knx,zwave")
binding = zwave,astro1,http,mqtt,nest,networkhealth,ntp