Skip to content

Commit d63bbc5

Browse files
committed
README.md: Update Versions
1 parent fbd7e80 commit d63bbc5

File tree

1 file changed

+40
-10
lines changed

1 file changed

+40
-10
lines changed

README.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docker image for alexa-fhem
22
A [FHEM](https://fhem.de/) complementary Docker image for Amazon alexa voice assistant, based on
3-
- [Node 22 - Debian bullseye-slim](https://hub.docker.com/_/node/tags?page=1&name=22-bullseye-slim)
3+
- [Node 22 - Debian bookworm-slim](https://hub.docker.com/_/node/tags?page=1&name=22-bookworm-slim)
44
- [alexa_fhem](https://www.npmjs.com/package/alexa-fhem?activeTab=versions)
55

66

@@ -14,17 +14,17 @@ Updated version, only with Version tags
1414
- NodeJS 22
1515
- Alexa-Fhem 0.5.65
1616

17-
docker pull ghcr.io/fhem/alexa-fhem:5.0.14
17+
docker pull ghcr.io/fhem/alexa-fhem:5.1.0-beta4
1818

1919
#### To start your container right away:
2020

21-
docker run -d --name alexa-fhem ghcr.io/fhem/alexa-fhem:5.0.14
21+
docker run -d --name alexa-fhem ghcr.io/fhem/alexa-fhem:5.1.0-beta4
2222

2323

2424
### Permanent storage
2525
Usually you want to keep your FHEM setup after a container was destroyed (or re-build) so it is a good idea to provide an external directory on your Docker host to keep that data:
2626

27-
docker run -d --name alexa-fhem -v /some/host/directory:/alexa-fhem ghcr.io/fhem/alexa-fhem:5.0.14
27+
docker run -d --name alexa-fhem -v /some/host/directory:/alexa-fhem ghcr.io/fhem/alexa-fhem:5.1.0-beta4
2828

2929
#### Verify if container is runnung
3030
After starting your container, you may check the web server availability:
@@ -46,7 +46,7 @@ You can use one of those variants by adding them to the docker image name like t
4646

4747
docker pull ghcr.io/fhem/alexa-fhem:latest
4848
docker pull ghcr.io/fhem/alexa-fhem:5
49-
docker pull ghcr.io/fhem/alexa-fhem:5.0.14
49+
docker pull ghcr.io/fhem/alexa-fhem:5.1.0-beta4
5050

5151
If you do not specify any variant, `latest` will always be the default.
5252

@@ -114,7 +114,7 @@ networks:
114114
services:
115115
# Minimum example w/o any custom environment variables of fhem container
116116
fhem:
117-
image: ghcr.io/fhem/fhem-docker:3-bullseye
117+
image: ghcr.io/fhem/fhem-docker:4-bullseye
118118
restart: always
119119
networks:
120120
- fhem_net
@@ -123,9 +123,9 @@ services:
123123
volumes:
124124
- "./fhem/:/opt/fhem/"
125125
126-
# Minimum example w/o any custom environment variables of alexa-fhem container
126+
# Minimum example with some custom environment variables of alexa-fhem container
127127
alexa-fhem:
128-
image: ghcr.io/fhem/alexa-fhem:5.0.14
128+
image: ghcr.io/fhem/alexa-fhem:5.1.0-beta4
129129
restart: always
130130
networks:
131131
- fhem_net
@@ -139,6 +139,11 @@ services:
139139

140140
If you use another name for your fhem container `fhem`, or want to use another tcp port for fhemweb connections, then you have to change the alexa-fhem config file in the volume for your alea-fhem container `./alexa-fhem/alexa-fhem.json`.
141141

142+
## Configuration of alexa-fhem container
143+
144+
The config file is placed in the volume /alexa-fhem.
145+
If not already present, it will be created here.
146+
142147
In the connections part, servername and port must match withhin fhem configuration:
143148
```
144149
"connections": [
@@ -153,15 +158,40 @@ In the connections part, servername and port must match withhin fhem configurati
153158
]
154159
```
155160

161+
Starting with Docker image version 5.1.x, you can control every setting via an environment variable provided by the Docker host. This means there is no need to edit any configuration files manually. All environment variables starting with the common prefix "CONFIG_" are evaluated and added to the configuration file.
162+
163+
To enable SSL for communication with FHEMweb, add an environment variable CONFIG_connections_0_ssl=true. If your container running FHEM is named differently, use the environment variable CONFIG_connections_0_server='fhem.docker.local'. To use another TCP port for communication with FHEM, set the environment variable CONFIG_connections_0_port='8088'.
164+
165+
The settings for Alexa can also be changed. Here are some examples:
166+
167+
`CONFIG_alexa_port=4000`
168+
`CONFIG_alexa_name=myAlexaSkill`
169+
`CONFIG_alexa_ssl=true`
170+
Additionally, the SSH proxy settings can be changed if needed:
171+
172+
`CONFIG_sshproxy_ssh='/usr/bin/ssh'`
173+
## Configuration of FHEM configuration
156174

157-
Within FHEM, you have to specify a alexa device and add attribute to identify the host. In this example, the container name is `alexa-fhem`, so this is also the hostname.
175+
Within FHEM, you have to specify a alexa device and add attribute to identify the host.
176+
In this example, the container name is `alexa-fhem`, so this is also the hostname.
158177

159178
```
160179
define alexa alexa
161180
attr alexa alexaFHEM-host alexa-fhem
162181
```
163182

164-
SSH and other attributes are not needed for running in a docker environment
183+
SSH and other attributes are not needed for running in a docker environment.
184+
alexa-fhem is running correctly if you have reading like this:
185+
186+
`alexaFHEM.ProxyConnection = running; SSH connected`
187+
`alexaFHEM.bearerToken = <some secret value>`
188+
`alexaFHEM.skillRegKey = crypt:<some long value>`
189+
190+
You will also see a internal `alexa-fhem version`
191+
192+
193+
194+
165195

166196
___
167197
[Production Build and Test](https://github.com/fhem/fhem/alexa-fhem-docker/workflows/Build%20and%20Test/badge.svg?branch=master)

0 commit comments

Comments
 (0)