Skip to content

Commit c4eeb2a

Browse files
committed
Docs: add infos on connecting to host and non linux/amd64 platforms
1 parent 2f3ed09 commit c4eeb2a

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

Docs/docs/01-Quick-Start/01-Server-Testing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ docker run \
4747
* Line 6: Specifies the Docker image from the TLS-Docker-Library
4848
* Lines 7-9: Flags passed to the OpenSSL `s_server` binary
4949

50+
:::note
51+
52+
Note, that if you are using a platform beyond linux/amd64 (e.g., on a **Macbook**), you might need to use the parameter `--platform linux/amd64` to correctly start the image.
53+
54+
:::
55+
5056
### Starting TLS-Anvil
5157

5258
Next, start TLS-Anvil. The current directory is mounted into the Docker container to store the results. We connect to the server using its Docker hostname `openssl-server`, which works because both containers are on the same Docker network.
@@ -78,6 +84,12 @@ docker run \
7884
* Line 13: Specifies that we want to test a server
7985
* Line 14: Details how TLS-Anvil should connect to the server
8086

87+
:::tip
88+
89+
If you want to connect to a server running on your host machine, and not in another container, you can either use the hostname `host.docker.internal` or set the docker network to `--network host` and use `localhost` as hostname.
90+
91+
:::
92+
8193
### What Now?
8294

8395
After the test suite finishes, you should see a folder named `Results_...` containing all the results.

Docs/docs/01-Quick-Start/02-Client-Testing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ docker run \
4949
* Line 14: Specifies the port TLS-Anvil listens on for client connections
5050
* Line 15: Provides a script that is executed before each handshake to trigger a new client connection. See explanation below.
5151

52+
:::tip
53+
54+
If you want the trigger script to execute on your host machine, we recommend to run the `TLS-Anvil.jar` executable directly on your host machine using Java 21 or newer. The jar files can be found under [Releases](https://github.com/tls-attacker/TLS-Anvil/releases).
55+
56+
:::
57+
5258
### Starting the OpenSSL Client Container
5359

5460
:::info
@@ -79,6 +85,12 @@ docker run \
7985
* Line 6: Specifies the OpenSSL client image from the TLS-Docker-Library
8086
* Line 7: This argument is passed to the OpenSSL `s_client` binary, which is executed each time a `GET /trigger` request is sent to port 8090
8187

88+
:::note
89+
90+
Note, that if you are using a platform beyond linux/amd64 (e.g., on a **Macbook**), you might need to use the parameter `--platform linux/amd64` to correctly start the image.
91+
92+
:::
93+
8294
### What Now?
8395

8496
After the test suite finishes, a folder named `Results_...` will appear in your working directory.

0 commit comments

Comments
 (0)