Skip to content

Commit

Permalink
sauce-connect(install): update docker installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mmatczuk committed Jul 19, 2024
1 parent 42a5fd7 commit 30f4e76
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/secure-connections/sauce-connect-5/operation/api-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,28 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Sauce Connect Proxy, optionally, exposes an API server that allows obtain information about the local Sauce Connect Proxy instance.
Sauce Connect Proxy, optionally, exposes an API server that allows to obtain information about the local Sauce Connect Proxy instance.
The API interface is configured with the [`--api-address`](/dev/cli/sauce-connect-5/run/#--api-address) flag.

```bash
--api-address :8080 # listens on all the interfaces' port 8080
--api-address 127.0.0.1:8081 # listens on 127.0.0.1 port 8081
--api-address 127.0.0.1:8080 # listens on 127.0.0.1 port 8080
```

## Docker

When running Sauce Connect Proxy in a container, the API server is enabled by default and listens on the containers' localhost port 10000.
Due to configuration options order of precedence, to change the API server address, you need to use the `SAUCE_API_ADDRESS` environment variable.

The following example shows how to start a Sauce Connect Proxy container with the API server accessible on port 8080 on the host machine.

```bash
docker run \
// your normal options
-e SAUCE_API_ADDRESS=':8080' \
-p 8080:8080
saucelabs/sauce-connect
```

## Endpoints

Expand Down

0 comments on commit 30f4e76

Please sign in to comment.