Skip to content

Commit

Permalink
Merge pull request #594 from hahwul/update-documents
Browse files Browse the repository at this point in the history
Update documentation for Docker usage and resource titles
  • Loading branch information
hahwul authored Dec 2, 2024
2 parents c827948 + 94d4218 commit 1156086
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/_community/resources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Resource
title: Resources
nav_order: 1
toc: true
layout: page
Expand Down
13 changes: 13 additions & 0 deletions docs/page/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,33 @@ Dalfox provides Docker images by version. This method allows you to use Dalfox w
### Pull the Latest Docker Image
To pull the latest Docker image of Dalfox, run:
```bash
# docker hub
docker pull hahwul/dalfox:latest

# ghcr
docker pull ghcr.io/hahwul/dalfox:latest
```

### Run Dalfox Using Docker
You can run Dalfox using Docker with the following command:
```bash
# docker hub
docker run -it hahwul/dalfox:latest /app/dalfox url https://www.hahwul.com

# ghcr
docker run -it ghcr.io/hahwul/dalfox:latest /app/dalfox url https://www.hahwul.com
```

### Interactive Docker Shell
For an interactive shell within the Docker container, run:
```bash
# docker hub
docker run -it hahwul/dalfox:latest /bin/bash

# ghcr
docker run -it ghcr.io/hahwul/dalfox:latest /bin/bash
```

Once inside the container, you can run Dalfox:
```bash
./dalfox
Expand Down
9 changes: 9 additions & 0 deletions docs/page/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,23 @@ This command will install the latest version of Dalfox from the source.
## Using Docker
If you are using Dalfox with Docker, you can update it by pulling the latest Docker image:
```bash
# dockerhub
docker pull hahwul/dalfox:latest

# ghcr
docker pull ghcr.io/hahwul/dalfox:latest
```
This command will download the latest Dalfox Docker image.

### Running the Updated Docker Image
After pulling the latest image, you can run Dalfox using the updated Docker image:

```bash
# docker hub
docker run -it hahwul/dalfox:latest /app/dalfox url https://www.hahwul.com

# ghcr
docker run -it ghcr.io/hahwul/dalfox:latest /app/dalfox url https://www.hahwul.com
```

## Additional Resources
Expand Down

0 comments on commit 1156086

Please sign in to comment.