This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 1830e78be83 chore: clarify docker advertised address (#1109)
1830e78be83 is described below
commit 1830e78be8387fd6f3b1d56179f7b1f678fabdac
Author: Zixuan Liu <[email protected]>
AuthorDate: Tue Apr 14 22:58:04 2026 +0800
chore: clarify docker advertised address (#1109)
---
docs/getting-started-docker.md | 13 ++++++++-----
versioned_docs/version-4.2.x/getting-started-docker.md | 13 ++++++++-----
2 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/docs/getting-started-docker.md b/docs/getting-started-docker.md
index a0f8daac01b..b6b5cc39cd6 100644
--- a/docs/getting-started-docker.md
+++ b/docs/getting-started-docker.md
@@ -38,7 +38,7 @@ docker run -it \
--mount source=pulsardata,target=/pulsar/data \
--mount source=pulsarconf,target=/pulsar/conf \
apachepulsar/pulsar:@pulsar:version@ \
-bin/pulsar standalone
+bin/pulsar standalone --advertised-address localhost
```
</TabItem>
@@ -52,7 +52,7 @@ docker run -it ^
--mount source=pulsardata,target=/pulsar/data ^
--mount source=pulsarconf,target=/pulsar/conf ^
apachepulsar/pulsar:@pulsar:version@ ^
-bin/pulsar standalone
+bin/pulsar standalone --advertised-address localhost
```
</TabItem>
@@ -62,6 +62,10 @@ bin/pulsar standalone
:::tip
+These examples set `--advertised-address localhost` to preserve the previous
local Docker behavior. A client can connect to `localhost:6650` on the host
machine, and the broker will also advertise `localhost` back to the client as
the address to use for subsequent connections.
+
+If you omit this option, Pulsar uses the container's FQDN by default. That
works when the advertised hostname is resolvable and reachable from your
clients, such as from other containers on the same network or from remote
hosts, but it can break host-machine clients if that FQDN is not reachable from
outside the container.
+
By default, Pulsar uses RocksDB as the metadata store, which is recommended
for standalone instances.
If you encounter issues with RocksDB or need compatibility with existing
ZooKeeper-based installations, you can use ZooKeeper as the metadata store by
adding:
@@ -95,7 +99,7 @@ docker run -it \
apachepulsar/pulsar:@pulsar:version@ sh \
-c "bin/apply-config-from-env.py \
conf/standalone.conf && \
-bin/pulsar standalone"
+bin/pulsar standalone --advertised-address localhost"
```
</TabItem>
@@ -112,7 +116,7 @@ docker run -it ^
apachepulsar/pulsar:@pulsar:version@ sh ^
-c "bin/apply-config-from-env.py ^
conf/standalone.conf && ^
-bin/pulsar standalone"
+bin/pulsar standalone --advertised-address localhost"
```
</TabItem>
@@ -297,4 +301,3 @@ The output is something like this:
"nonContiguousDeletedMessagesRangesSerializedSize": 0
}
```
-
diff --git a/versioned_docs/version-4.2.x/getting-started-docker.md
b/versioned_docs/version-4.2.x/getting-started-docker.md
index a0f8daac01b..b6b5cc39cd6 100644
--- a/versioned_docs/version-4.2.x/getting-started-docker.md
+++ b/versioned_docs/version-4.2.x/getting-started-docker.md
@@ -38,7 +38,7 @@ docker run -it \
--mount source=pulsardata,target=/pulsar/data \
--mount source=pulsarconf,target=/pulsar/conf \
apachepulsar/pulsar:@pulsar:version@ \
-bin/pulsar standalone
+bin/pulsar standalone --advertised-address localhost
```
</TabItem>
@@ -52,7 +52,7 @@ docker run -it ^
--mount source=pulsardata,target=/pulsar/data ^
--mount source=pulsarconf,target=/pulsar/conf ^
apachepulsar/pulsar:@pulsar:version@ ^
-bin/pulsar standalone
+bin/pulsar standalone --advertised-address localhost
```
</TabItem>
@@ -62,6 +62,10 @@ bin/pulsar standalone
:::tip
+These examples set `--advertised-address localhost` to preserve the previous
local Docker behavior. A client can connect to `localhost:6650` on the host
machine, and the broker will also advertise `localhost` back to the client as
the address to use for subsequent connections.
+
+If you omit this option, Pulsar uses the container's FQDN by default. That
works when the advertised hostname is resolvable and reachable from your
clients, such as from other containers on the same network or from remote
hosts, but it can break host-machine clients if that FQDN is not reachable from
outside the container.
+
By default, Pulsar uses RocksDB as the metadata store, which is recommended
for standalone instances.
If you encounter issues with RocksDB or need compatibility with existing
ZooKeeper-based installations, you can use ZooKeeper as the metadata store by
adding:
@@ -95,7 +99,7 @@ docker run -it \
apachepulsar/pulsar:@pulsar:version@ sh \
-c "bin/apply-config-from-env.py \
conf/standalone.conf && \
-bin/pulsar standalone"
+bin/pulsar standalone --advertised-address localhost"
```
</TabItem>
@@ -112,7 +116,7 @@ docker run -it ^
apachepulsar/pulsar:@pulsar:version@ sh ^
-c "bin/apply-config-from-env.py ^
conf/standalone.conf && ^
-bin/pulsar standalone"
+bin/pulsar standalone --advertised-address localhost"
```
</TabItem>
@@ -297,4 +301,3 @@ The output is something like this:
"nonContiguousDeletedMessagesRangesSerializedSize": 0
}
```
-
