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.

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

docs: add demo in readme #22

Merged
merged 1 commit into from
May 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,29 @@ TerraformGoat is built using Dockerfile, so you need to install the Docker envir

```shell
git clone https://github.com/HuoCorp/TerraformGoat.git
cd terraformgoat
docker build -t terraformgoat:v0.1 .
cd TerraformGoat
docker build -t terraformgoat:v0.0.2 .
```

![img](./images/1651136182.png)
![img](./images/1652250379.png)

After docker build is complete, start and enter the container

```shell
docker run -itd --name terraformgoat terraformgoat:v0.1
docker run -itd --name terraformgoat terraformgoat:v0.0.2
docker exec -it terraformgoat /bin/bash
```

When entering the container, you need to select the cloud service to run

![img](./images/1651136346.png)
![img](./images/1652250438.png)

After selecting the cloud service you want to use, the relevant dependencies will be installed. After the relevant dependencies are installed, you can use TerraformGoat.

Using the build of the Alibaba Cloud ECS SSRF vulnerability scenario as a demo:

[![asciicast](https://asciinema.org/a/493554.svg)](https://asciinema.org/a/493554)

## :rocket: Uninstall

```shell
Expand Down
16 changes: 10 additions & 6 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,31 +43,35 @@ TerraformGoat 使用 Dockerfile 构建,因此需要先安装 Docker 环境,D

```shell
git clone https://github.com/HuoCorp/TerraformGoat.git
cd terraformgoat
docker build -t terraformgoat:v0.1 .
cd TerraformGoat
docker build -t terraformgoat:v0.0.2 .
```

![img](./images/1651136182.png)
![img](./images/1652250379.png)

docker build 完成后,启动并进入容器

```shell
docker run -itd --name terraformgoat terraformgoat:v0.1
docker run -itd --name terraformgoat terraformgoat:v0.0.2
docker exec -it terraformgoat /bin/bash
```

在进入容器时需要选择要使用到的云服务

![img](./images/1651136346.png)
![img](./images/1652250438.png)

选择你要用的云服务后会安装相关依赖,等相关依赖安装完后,就可以使用 TerraformGoat 了

这里以阿里云 ECS SSRF 漏洞场景的搭建进行演示:

[![asciicast](https://asciinema.org/a/493554.svg)](https://asciinema.org/a/493554)

## :rocket: 卸载

```shell
docker stop terraformgoat
docker rm terraformgoat
docker rmi terraformgoat:v0.1
docker rmi terraformgoat:v0.0.2
```

## ⚠️ 注意事项
Expand Down
Binary file removed images/1651136182.png
Binary file not shown.
Binary file removed images/1651136346.png
Binary file not shown.
Binary file added images/1652250379.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/1652250438.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.