Skip to content

Commit

Permalink
chore: correct address in README (#2274)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackwotherspoon authored Jul 22, 2024
1 parent a2070bf commit fc9bb64
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,14 +434,13 @@ The containers have the proxy as an `ENTRYPOINT` so, to use the proxy from a
container, all you need to do is specify options using the command, and expose
the proxy's internal port to the host. For example, you can use:
<!-- {x-release-please-start-version} -->
```shell
docker run --publish <host-port>:<proxy-port> \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.12.0 \
--address "2.12.0.0" --port <proxy-port> <instance-connection-name>
gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest \
--address "0.0.0.0" --port <proxy-port> <instance-connection-name>
```
You'll need the `--address "2.12.0.0"` so that the proxy doesn't only listen for
You'll need the `--address "0.0.0.0"` so that the proxy doesn't only listen for
connections originating from *within* the container.
You will need to authenticate using one of the methods outlined in the
Expand All @@ -465,12 +464,11 @@ For example, a full command using a JSON credentials file might look like
docker run \
--publish <host-port>:<proxy-port> \
--mount type=bind,source="$(pwd)"/sa.json,target=/config/sa.json \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.12.0 \
--address 2.12.0.0 \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest \
--address 0.0.0.0 \
--port <proxy-port> \
--credentials-file /config/sa.json <instance-connection-name>
```
<!-- {x-release-please-end} -->
## Running as a Kubernetes Sidecar
Expand Down

0 comments on commit fc9bb64

Please sign in to comment.