Skip to content

Commit

Permalink
[ci skip] Update openHAB versions in README.md
Browse files Browse the repository at this point in the history
Jenkins build 4368
  • Loading branch information
openhab-bot committed Dec 15, 2024
1 parent 4964a18 commit 2b10850
Showing 1 changed file with 17 additions and 20 deletions.
37 changes: 17 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![Build Status](https://ci.openhab.org/job/openHAB-Docker/badge/icon)](https://ci.openhab.org/job/openHAB-Docker/)
[![EPL-2.0](https://img.shields.io/badge/license-EPL%202-green.svg)](https://opensource.org/licenses/EPL-2.0)
[![Docker Version](https://img.shields.io/badge/version-4.2.3-blue)](https://hub.docker.com/repository/docker/openhab/openhab/tags?name=4.2.3)
[![Docker Version](https://img.shields.io/badge/version-4.3.0-blue)](https://hub.docker.com/repository/docker/openhab/openhab/tags?name=4.3.0)
[![Docker Stars](https://img.shields.io/docker/stars/openhab/openhab.svg?cacheSeconds=2592000)](https://hub.docker.com/r/openhab/openhab/)
[![Docker Pulls](https://img.shields.io/docker/pulls/openhab/openhab.svg?cacheSeconds=2592000)](https://hub.docker.com/r/openhab/openhab/)
[![GitHub Issues](https://img.shields.io/github/issues/openhab/openhab-docker.svg)](https://github.com/openhab/openhab-docker/issues)
Expand Down Expand Up @@ -68,13 +68,10 @@ The openHAB Docker images are available in the [openhab/openhab](https://hub.doc
**Versions:**

* **Stable:** Thoroughly tested semi-annual official releases of openHAB. Use the stable version for your production environment if you do not need the latest enhancements and prefer a robust system.
* `4.3.0` ([Release notes](https://github.com/openhab/openhab-distro/releases/tag/4.3.0))
* `4.2.3` ([Release notes](https://github.com/openhab/openhab-distro/releases/tag/4.2.3))
* `4.1.3` ([Release notes](https://github.com/openhab/openhab-distro/releases/tag/4.1.3))
* **Milestone:** Intermediary releases of the next openHAB version which are released about once a month. They include recently added features and bugfixes and are a good compromise between the current stable version and the bleeding-edge and potentially unstable snapshot version.
* `4.3.0.RC1` ([Release notes](https://github.com/openhab/openhab-distro/releases/tag/4.3.0.RC1))
* `4.3.0.M5` ([Release notes](https://github.com/openhab/openhab-distro/releases/tag/4.3.0.M5))
* **Snapshot:** Usually 1 or 2 days old and include the latest code. Use these for testing out very recent changes using the latest code. Be aware that some snapshots might be unstable so use these in production at your own risk!
* `4.3.0-snapshot`
* `5.0.0-snapshot`

**Distributions:**

Expand All @@ -84,7 +81,7 @@ The openHAB Docker images are available in the [openhab/openhab](https://hub.doc
The Alpine images are substantially smaller than the Debian images but may be less compatible because OpenJDK is used (see [Prerequisites](https://www.openhab.org/docs/installation/#prerequisites) for known disadvantages).
Older container images may use older versions of the Debian and Alpine base images.

If you are unsure about what your needs are, you probably want to use `openhab/openhab:4.2.3`.
If you are unsure about what your needs are, you probably want to use `openhab/openhab:4.3.0`.

**Platforms:**

Expand All @@ -104,7 +101,7 @@ There is no `linux/arm/v7` Alpine image for openHAB 3 (or newer) because the req

The following will run openHAB in demo mode on the host machine:

`docker run --name openhab --net=host openhab/openhab:4.2.3`
`docker run --name openhab --net=host openhab/openhab:4.3.0`

_**NOTE:** Although this is the simplest method to getting openHAB up and running, but it is not the preferred method.
To properly run the container, please specify a **host volume** for the directories._
Expand Down Expand Up @@ -133,7 +130,7 @@ docker run \
-e "EXTRA_JAVA_OPTS=-Duser.timezone=Europe/Berlin" \
-d \
--restart=always \
openhab/openhab:4.2.3
openhab/openhab:4.3.0
```

#### Running from compose-file.yml
Expand All @@ -143,7 +140,7 @@ Create the following `docker-compose.yml` for use of local directories and start
```yaml
services:
openhab:
image: "openhab/openhab:4.2.3"
image: "openhab/openhab:4.3.0"
restart: always
network_mode: host
volumes:
Expand All @@ -164,7 +161,7 @@ Create the following `docker-compose.yml` for use of Docker volumes and start th
```yml
services:
openhab:
image: "openhab/openhab:4.2.3"
image: "openhab/openhab:4.3.0"
restart: always
network_mode: host
volumes:
Expand Down Expand Up @@ -198,7 +195,7 @@ Create the following `docker-compose.yml` and start the container with `docker c
services:
openhab:
container_name: openhab
image: "openhab/openhab:4.2.3"
image: "openhab/openhab:4.3.0"
restart: always
network_mode: host
cap_add:
Expand All @@ -220,7 +217,7 @@ On Windows and macOS ports should be exposed by adding port options to commands
```yaml
services:
openhab:
image: "openhab/openhab:4.2.3"
image: "openhab/openhab:4.3.0"
restart: always
ports:
- "8080:8080"
Expand Down Expand Up @@ -253,7 +250,7 @@ docker run \
-v /opt/openhab/userdata:/openhab/userdata \
-e "CRYPTO_POLICY=unlimited" \
-e "EXTRA_JAVA_OPTS=-Duser.timezone=Europe/Berlin" \
openhab/openhab:4.2.3
openhab/openhab:4.3.0
```

### Automating Docker setup using Ansible (for advanced user)
Expand All @@ -272,7 +269,7 @@ If run elsewhere, replace it with ro.
tags: openhab
docker_container:
name: openhab
image: openhab/openhab:4.2.3
image: openhab/openhab:4.3.0
state: started
detach: yes
ports:
Expand Down Expand Up @@ -309,7 +306,7 @@ The default password for the login is: `habopen`

The container starts openHAB in server mode when no TTY is provided, example:

`docker run --detach --name openhab openhab/openhab:4.2.3`
`docker run --detach --name openhab openhab/openhab:4.3.0`

When the container runs in server mode you can also add a console logger so it prints logging to stdout so you can check the logging of a container named "openhab" with:

Expand All @@ -326,13 +323,13 @@ To use a console logger with openHAB 2, edit `userdata/etc/org.ops4j.pax.logging

When a TTY is provided openHAB is started with an interactive console, e.g.:

`docker run -it openhab/openhab:4.2.3`
`docker run -it openhab/openhab:4.3.0`

#### Debug mode

The debug mode is started with the command:

`docker run -it openhab/openhab:4.2.3 ./start_debug.sh`
`docker run -it openhab/openhab:4.3.0 ./start_debug.sh`

## Environment variables

Expand Down Expand Up @@ -507,7 +504,7 @@ For more information on this see the [Docker documentation](https://docs.docker.
Checkout the GitHub repository, change to a directory containing a Dockerfile (e.g. `/debian`) and then run these commands to build and run a Docker image for your current platform:

```shell
$ docker build --build-arg JAVA_VERSION=17 --build-arg OPENHAB_VERSION=4.2.3 --tag openhab/openhab .
$ docker build --build-arg JAVA_VERSION=17 --build-arg OPENHAB_VERSION=4.3.0 --tag openhab/openhab .
$ docker run openhab/openhab
```

Expand All @@ -523,7 +520,7 @@ $ docker buildx create --name builder --use
Change to a directory containing a Dockerfile (e.g. `/debian`) and then use the following command to build an ARMv7 image:

```shell
$ docker buildx build --build-arg JAVA_VERSION=17 --build-arg OPENHAB_VERSION=4.2.3 --platform linux/arm/v7 --tag openhab/openhab --load .
$ docker buildx build --build-arg JAVA_VERSION=17 --build-arg OPENHAB_VERSION=4.3.0 --platform linux/arm/v7 --tag openhab/openhab --load .
```

The `build` script in the root of the repository helps to simplify building the openHAB images with BuildKit.
Expand Down

0 comments on commit 2b10850

Please sign in to comment.