Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust docker installation guide #15

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Adjust docker installation guide #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The first build will take some time to complete and will vary based on the provi
* Jason Andress (@jandress)
* @0x48piraj
* Abdallah Ajjawi (@lefanous)
* Amar Djebarra (@GeekMuch)
* Amar Djebbara (@GeekMuch)

### Screenshots

Expand Down
16 changes: 8 additions & 8 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ To run this environment, ensure you have the following installed:

### 1. Clone the Repository

First, clone the repository to your local machine:
First, clone the repository to your local machine and navigate to the `docker` directory inside the cloned repository:

```bash
git clone https://github.com/OWASP/IoTGoat
cd IoTGoat
cd IoTGoat/docker
```

### 2. Fetch and Convert the IoTGoat Image
Expand Down Expand Up @@ -79,7 +79,7 @@ This will:

### 5. Accessing the Services

After running `docker-compose up --build`, the following services will be available:
After running `docker compose up --build`, the following services will be available:

#### SSH Access

Expand Down Expand Up @@ -112,7 +112,7 @@ https://localhost:4443
To stop the running container, press `CTRL+C` in the terminal running Docker Compose, or use:

```bash
docker-compose down
docker compose down
```

This will stop and remove the container.
Expand All @@ -124,15 +124,15 @@ The IoTGoat environment is configured to persist its data inside a Docker volume
To remove the volume and reset the environment, use:

```bash
docker-compose down -v
docker compose down -v
```

### 8. Rebuilding the Container

If you make changes to the `Dockerfile.qemu` or the project files, rebuild the container using:

```bash
docker-compose up --build
docker compose up --build
```

---
Expand All @@ -141,8 +141,8 @@ docker-compose up --build

- Verify SSH configuration and exposed ports to mitigate potential security risks and usage of default credentials.
- Ensure Docker and Docker Compose are correctly installed and running on your system.
- If you encounter any issues with ports, ensure that the ports specified in `docker-compose.yml` (2222, 8080, 4443) are available on your host system.
- For a clean environment reset, use `docker-compose down -v` to remove volumes and the container.
- If you encounter any issues with ports, ensure that the ports specified in `docker compose.yml` (2222, 8080, 4443) are available on your host system.
- For a clean environment reset, use `docker compose down -v` to remove volumes and the container.
- QEMU is required on the host machine solely for using the qemu-img tool to convert the IoTGoat image to qcow2 format. It is not needed for any other tasks on the host.
- Ensure proper permissions for the `IoTGoat-x86.qcow2` file. Especially if Docker cannot access it. Run the following command to fix it:

Expand Down