Skip to content

Commit edfbb8c

Browse files
Run update.sh
1 parent 9106efc commit edfbb8c

File tree

6 files changed

+30
-55
lines changed

6 files changed

+30
-55
lines changed

dart/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ WARNING:
2424

2525
# Supported tags and respective `Dockerfile` links
2626

27-
- [`3.4.3-sdk`, `3.4-sdk`, `3-sdk`, `stable-sdk`, `sdk`, `3.4.3`, `3.4`, `3`, `stable`, `latest`](https://github.com/dart-lang/dart-docker/blob/6ac1650f30c0253aee1be07ceab3d8860efe7d2a/stable/bookworm/Dockerfile)
28-
- [`3.5.0-180.3.beta-sdk`, `beta-sdk`, `3.5.0-180.3.beta`, `beta`](https://github.com/dart-lang/dart-docker/blob/6ac1650f30c0253aee1be07ceab3d8860efe7d2a/beta/bookworm/Dockerfile)
27+
- [`3.4.4-sdk`, `3.4-sdk`, `3-sdk`, `stable-sdk`, `sdk`, `3.4.4`, `3.4`, `3`, `stable`, `latest`](https://github.com/dart-lang/dart-docker/blob/d3658d21b1bd35658346d3fb4345d9a8084759e5/stable/bookworm/Dockerfile)
28+
- [`3.5.0-180.3.beta-sdk`, `beta-sdk`, `3.5.0-180.3.beta`, `beta`](https://github.com/dart-lang/dart-docker/blob/d3658d21b1bd35658346d3fb4345d9a8084759e5/beta/bookworm/Dockerfile)
2929

3030
# Quick reference (cont.)
3131

elasticsearch/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ WARNING:
2525
# Supported tags and respective `Dockerfile` links
2626

2727
- [`8.14.1`](https://github.com/elastic/dockerfiles/blob/69af7042cfc0b32c0d9de82110f15ff8dd74ded8/elasticsearch/Dockerfile)
28-
- [`7.17.21`](https://github.com/elastic/dockerfiles/blob/948af89c718b515fa24fa06f6a6890ed32e3b120/elasticsearch/Dockerfile)
28+
- [`7.17.22`](https://github.com/elastic/dockerfiles/blob/1f54f19c85034114800de30ef9929c9b52947ffb/elasticsearch/Dockerfile)
2929

3030
# Quick reference (cont.)
3131

emqx/README.md

Lines changed: 17 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -85,51 +85,35 @@ The EMQX broker runs as Linux user `emqx` in the docker container.
8585

8686
All EMQX Configuration in [`etc/emqx.conf`](https://github.com/emqx/emqx/blob/master/apps/emqx/etc/emqx.conf) can be configured via environment variables.
8787

88-
By default, the environment variables with `EMQX_` prefix are mapped to key-value pairs in configuration files.
89-
90-
You can change the prefix by overriding `HOCON_ENV_OVERRIDE_PREFIX`.
91-
9288
Example:
9389

94-
```bash
95-
EMQX_LISTENERS__SSL__DEFAULT__ACCEPTORS <--> listeners.ssl.default.acceptors
96-
EMQX_ZONES__DEFAULT__MQTT__MAX_PACKET_SIZE <--> zones.default.mqtt.max_packet_size
97-
```
90+
EMQX_DASHBOARD__DEFAULT_PASSWORD <--> dashboard.default_password
91+
EMQX_NODE__COOKIE <--> node.cookie
92+
EMQX_LISTENERS__SSL__default__ENABLE <--> listeners.ssl.default.enable
93+
94+
Note: The lowercase use of 'default' is not a typo. It is used to demonstrate that lowercase environment variables are equivalent.
9895

9996
- Prefix `EMQX_` is removed
100-
- All upper case letters is replaced with lower case letters
97+
- All upper case letters are replaced with lower case letters
10198
- `__` is replaced with `.`
10299

103-
If `HOCON_ENV_OVERRIDE_PREFIX=DEV_` is set:
104-
105-
```bash
106-
DEV_LISTENER__SSL__EXTERNAL__ACCEPTORS <--> listener.ssl.external.acceptors
107-
DEV_MQTT__MAX_PACKET_SIZE <--> mqtt.max_packet_size
108-
DEV_LISTENERS__TCP__DEFAULT__BIND <--> listeners.tcp.default.bind
109-
```
110-
111100
For example, set MQTT TCP port to 1883
112101

113102
```console
114-
$ docker run -d --name emqx -e DEV_LISTENERS__TCP__DEFAULT__BIND=1883 -p 18083:18083 -p 1883:1883 emqx:latest
103+
$ docker run -d --name emqx -e EMQX_DASHBOARD__DEFAULT_PASSWORD=mysecret -p 18083:18083 -p 1883:1883 emqx:latest
115104
```
116105

117-
Please read more about EMQX configuration in the [official documentation](https://www.emqx.io/docs/en/v5.0/admin/cfg.html).
106+
Please read more about EMQX configuration in the [official documentation](https://docs.emqx.com/en/emqx/latest/configuration/configuration.html)
118107

119108
#### EMQX node name configuration
120109

121-
| Options | Default | Mapped | Description |
122-
|-------------|----------------|--------|----------------------------|
123-
| `EMQX_NAME` | container name | none | EMQX node short name |
124-
| `EMQX_HOST` | container IP | none | EMQX node host, IP or FQDN |
110+
Environment variable `EMQX_NODE__NAME` allows you to specify an EMQX node name, which defaults to `<container_name>@<container_ip>`.
125111

126-
These environment variables are used during container startup phase only in [docker-entrypoint.sh](./docker-entrypoint.sh).
127-
128-
If `EMQX_NAME` and `EMQX_HOST` are set, and `EMQX_NODE_NAME` is not set, `EMQX_NODE_NAME=$EMQX_NAME@$EMQX_HOST`. Otherwise `EMQX_NODE_NAME` is taken verbatim.
112+
If not specified, EMQX determines its node name based on the running environment or other environment variables used for node discovery.
129113

130114
### Cluster
131115

132-
EMQX supports a variety of clustering methods, see our [documentation](https://www.emqx.io/docs/en/latest/deploy/cluster/intro.html) for details.
116+
EMQX supports a variety of clustering methods, see our [documentation](https://docs.emqx.com/en/emqx/latest/deploy/cluster/create-cluster.html) for details.
133117

134118
Let's create a static node list cluster from docker-compose.
135119

@@ -142,8 +126,7 @@ Let's create a static node list cluster from docker-compose.
142126
emqx1:
143127
image: emqx:latest
144128
environment:
145-
- "EMQX_NAME=emqx"
146-
- "EMQX_HOST=node1.emqx.io"
129+
- "EMQX_NODE__NAME=emqx@node1.emqx.io"
147130
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
148131
- "EMQX_CLUSTER__STATIC__SEEDS=[emqx@node1.emqx.io, emqx@node2.emqx.io]"
149132
networks:
@@ -154,8 +137,7 @@ Let's create a static node list cluster from docker-compose.
154137
emqx2:
155138
image: emqx:latest
156139
environment:
157-
- "EMQX_NAME=emqx"
158-
- "EMQX_HOST=node2.emqx.io"
140+
- "EMQX_NODE__NAME=emqx@node2.emqx.io"
159141
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
160142
- "EMQX_CLUSTER__STATIC__SEEDS=[emqx@node1.emqx.io, emqx@node2.emqx.io]"
161143
networks:
@@ -177,7 +159,7 @@ Let's create a static node list cluster from docker-compose.
177159
- View cluster
178160

179161
```bash
180-
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx_ctl cluster status"
162+
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
181163
Cluster status: #{running_nodes => ['emqx@node1.emqx.io','emqx@node2.emqx.io'],
182164
stopped_nodes => []}
183165
```
@@ -187,19 +169,16 @@ Let's create a static node list cluster from docker-compose.
187169
If you want to persist the EMQX docker container, you need to keep the following directories:
188170

189171
- `/opt/emqx/data`
190-
- `/opt/emqx/etc`
191172
- `/opt/emqx/log`
192173

193-
Since data in these folders are partially stored under the `/opt/emqx/data/mnesia/${node_name}`, the user also needs to reuse the same node name to see the previous state. In detail, one needs to specify the two environment variables: `EMQX_NAME` and `EMQX_HOST`, `EMQX_HOST` set as `127.0.0.1` or network alias would be useful.
174+
Since data in these folders are partially stored under the `/opt/emqx/data/mnesia/${node_name}`, the user also needs to reuse the same node name to see the previous state. To make this work, one needs to set the host part of `EMQX_NODE__NAME` to something static that does not change when you restart or recreate the container. It could be container name, hostname or loopback IP address `127.0.0.1` if you only have one node.
194175

195176
In if you use docker-compose, the configuration would look something like this:
196177

197178
```YAML
198179
volumes:
199180
vol-emqx-data:
200181
name: foo-emqx-data
201-
vol-emqx-etc:
202-
name: foo-emqx-etc
203182
vol-emqx-log:
204183
name: foo-emqx-log
205184

@@ -208,19 +187,15 @@ services:
208187
image: emqx:latest
209188
restart: always
210189
environment:
211-
EMQX_NAME: foo_emqx
212-
EMQX_HOST: 127.0.0.1
190+
EMQX_NODE__NAME: foo_emqx@127.0.0.1
213191
volumes:
214192
- vol-emqx-data:/opt/emqx/data
215-
- vol-emqx-etc:/opt/emqx/etc
216193
- vol-emqx-log:/opt/emqx/log
217194
```
218195
219-
Note that `/opt/emqx/etc` contains some essential configuration files. If you want to mount a host directory in the container to persist configuration overrides, you will need to bootstrap it with [default configuration files](https://github.com/emqx/emqx/tree/master/apps/emqx/etc).
220-
221196
### Kernel Tuning
222197
223-
Under Linux host machine, the easiest way is [Tuning guide](https://www.emqx.io/docs/en/latest/deploy/tune.html).
198+
Under Linux host machine, the easiest way is [Tuning guide](https://docs.emqx.com/en/emqx/latest/performance/tune.html).
224199
225200
If you want tune Linux kernel by docker, you must ensure your docker is latest version (>=1.12).
226201

kibana/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ WARNING:
2525
# Supported tags and respective `Dockerfile` links
2626

2727
- [`8.14.1`](https://github.com/elastic/dockerfiles/blob/69af7042cfc0b32c0d9de82110f15ff8dd74ded8/kibana/Dockerfile)
28-
- [`7.17.21`](https://github.com/elastic/dockerfiles/blob/948af89c718b515fa24fa06f6a6890ed32e3b120/kibana/Dockerfile)
28+
- [`7.17.22`](https://github.com/elastic/dockerfiles/blob/1f54f19c85034114800de30ef9929c9b52947ffb/kibana/Dockerfile)
2929

3030
# Quick reference (cont.)
3131

logstash/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ WARNING:
2525
# Supported tags and respective `Dockerfile` links
2626

2727
- [`8.14.1`](https://github.com/elastic/dockerfiles/blob/69af7042cfc0b32c0d9de82110f15ff8dd74ded8/logstash/Dockerfile)
28-
- [`7.17.21`](https://github.com/elastic/dockerfiles/blob/948af89c718b515fa24fa06f6a6890ed32e3b120/logstash/Dockerfile)
28+
- [`7.17.22`](https://github.com/elastic/dockerfiles/blob/1f54f19c85034114800de30ef9929c9b52947ffb/logstash/Dockerfile)
2929

3030
# Quick reference (cont.)
3131

rust/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ WARNING:
2424

2525
# Supported tags and respective `Dockerfile` links
2626

27-
- [`1-buster`, `1.78-buster`, `1.78.0-buster`, `buster`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/buster/Dockerfile)
28-
- [`1-slim-buster`, `1.78-slim-buster`, `1.78.0-slim-buster`, `slim-buster`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/buster/slim/Dockerfile)
29-
- [`1-bullseye`, `1.78-bullseye`, `1.78.0-bullseye`, `bullseye`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/bullseye/Dockerfile)
30-
- [`1-slim-bullseye`, `1.78-slim-bullseye`, `1.78.0-slim-bullseye`, `slim-bullseye`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/bullseye/slim/Dockerfile)
31-
- [`1-bookworm`, `1.78-bookworm`, `1.78.0-bookworm`, `bookworm`, `1`, `1.78`, `1.78.0`, `latest`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/bookworm/Dockerfile)
32-
- [`1-slim-bookworm`, `1.78-slim-bookworm`, `1.78.0-slim-bookworm`, `slim-bookworm`, `1-slim`, `1.78-slim`, `1.78.0-slim`, `slim`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/bookworm/slim/Dockerfile)
33-
- [`1-alpine3.19`, `1.78-alpine3.19`, `1.78.0-alpine3.19`, `alpine3.19`](https://github.com/rust-lang/docker-rust/blob/cc31986e1dfe94671c639231ecf0503942c121d9/1.78.0/alpine3.19/Dockerfile)
34-
- [`1-alpine3.20`, `1.78-alpine3.20`, `1.78.0-alpine3.20`, `alpine3.20`, `1-alpine`, `1.78-alpine`, `1.78.0-alpine`, `alpine`](https://github.com/rust-lang/docker-rust/blob/e2c6ff15ac68eb3ca95d05c491a48127936b40bd/1.78.0/alpine3.20/Dockerfile)
27+
- [`1-buster`, `1.79-buster`, `1.79.0-buster`, `buster`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/buster/Dockerfile)
28+
- [`1-slim-buster`, `1.79-slim-buster`, `1.79.0-slim-buster`, `slim-buster`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/buster/slim/Dockerfile)
29+
- [`1-bullseye`, `1.79-bullseye`, `1.79.0-bullseye`, `bullseye`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/bullseye/Dockerfile)
30+
- [`1-slim-bullseye`, `1.79-slim-bullseye`, `1.79.0-slim-bullseye`, `slim-bullseye`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/bullseye/slim/Dockerfile)
31+
- [`1-bookworm`, `1.79-bookworm`, `1.79.0-bookworm`, `bookworm`, `1`, `1.79`, `1.79.0`, `latest`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/bookworm/Dockerfile)
32+
- [`1-slim-bookworm`, `1.79-slim-bookworm`, `1.79.0-slim-bookworm`, `slim-bookworm`, `1-slim`, `1.79-slim`, `1.79.0-slim`, `slim`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/bookworm/slim/Dockerfile)
33+
- [`1-alpine3.19`, `1.79-alpine3.19`, `1.79.0-alpine3.19`, `alpine3.19`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/alpine3.19/Dockerfile)
34+
- [`1-alpine3.20`, `1.79-alpine3.20`, `1.79.0-alpine3.20`, `alpine3.20`, `1-alpine`, `1.79-alpine`, `1.79.0-alpine`, `alpine`](https://github.com/rust-lang/docker-rust/blob/ea4aab0935fcafe4956d6206f3ecde84ffddf800/1.79.0/alpine3.20/Dockerfile)
3535

3636
# Quick reference (cont.)
3737

0 commit comments

Comments
 (0)