Skip to content

Commit 3c78082

Browse files
committed
Update documentation
1 parent 7d8ea2d commit 3c78082

3 files changed

Lines changed: 11 additions & 4 deletions

File tree

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains the documentation of the SSH labs.
44

55
The documentation is available on https://sshlabs.compass-security.training.
66

7-
[![Build and Publish Documentation](https://github.com/emanuelduss/ssh-labs/actions/workflows/docs.yml/badge.svg)](https://github.com/emanuelduss/ssh-labs/actions/workflows/docs.yml)
7+
[![Build and Publish Documentation](https://github.com/compasssecurity/ssh-labs/actions/workflows/docs.yml/badge.svg)](https://github.com/compasssecurity/ssh-labs/actions/workflows/docs.yml)
88

99
You can build the static documentation site from the Markdown files yourself
1010
using Zensical.

doc/docs/labs/02-getting-started.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ As a prerequisite, you need to have Docker installed on your system. See the off
77
Download the SSH labs Docker compose file:
88

99
```{.bash .copy}
10+
mkdir /tmp/ssh-labs
11+
cd /tmp/ssh-labs
12+
1013
curl -O https://raw.githubusercontent.com/CompassSecurity/ssh-labs/refs/heads/main/compose.yml
1114
```
1215

@@ -17,7 +20,7 @@ docker compose up
1720
```
1821

1922

20-
Wait until the images are built and started.
23+
Wait until the images are downloaded and started.
2124

2225
## Accessing the Attacker's Machine
2326

@@ -103,4 +106,8 @@ You are now ready to start the lab. Have fun!
103106

104107
## Stopping the Lab
105108

106-
Press Ctrl-C in the terminal where you started the labs to stop it.
109+
Press Ctrl-C in the terminal where you started the labs to stop it or stop it using the `docker` command in the directory where you downloaded the `compose.ym` file:
110+
111+
```bash
112+
docker compose down
113+
```

src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This directory contains the files to build the container images for the SSH lab.
44

5-
[![Build and Push Docker Images](https://github.com/emanuelduss/ssh-labs/actions/workflows/docker.yml/badge.svg)](https://github.com/emanuelduss/ssh-labs/actions/workflows/docker.yml)
5+
[![Build and Push Docker Images](https://github.com/compasssecurity/ssh-labs/actions/workflows/docker.yml/badge.svg)](https://github.com/compasssecurity/ssh-labs/actions/workflows/docker.yml)

0 commit comments

Comments
 (0)