aykhans/dodo
1
0
Fork 0
mirror of https://github.com/aykhans/dodo.git synced 2025-04-20 19:13:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📚 Update README.md with Docker installation instructions

Browse Source
This commit is contained in:
Aykhan Shahsuvarov 2024-07-26 00:04:26 +04:00
parent b74ec949e1
commit 16cb8499ce
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -4,10 +4,19 @@
</p> </p>
## Installation ## Installation
### With Docker (Recommended)
Pull the Dodo image from Docker Hub:
```sh
docker pull aykhans/dodo:latest
```
If you use Dodo with Docker and a config file, you must provide the config.json file as a volume to the Docker run command (not as the "-c config.json" argument), as shown in the examples in the [usage](#usage) section.
### With Binary File
You can grab binaries in the [releases](https://github.com/aykhans/dodo/releases) section. You can grab binaries in the [releases](https://github.com/aykhans/dodo/releases) section.
### Build from Source ### Build from Source
To build Dodo from source, you need to have [Go1.22+](https://golang.org/dl/) installed. Follow the steps below: To build Dodo from source, you need to have [Go1.22+](https://golang.org/dl/) installed. <br>
Follow the steps below to build dodo:
1. **Clone the repository:** 1. **Clone the repository:**
@ -38,6 +47,10 @@ Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) a
```sh ```sh
dodo -u https://example.com -m GET -d 10 -r 1000 -t 2000 dodo -u https://example.com -m GET -d 10 -r 1000 -t 2000
``` ```
With Docker:
```sh
docker run --rm aykhans/dodo -u https://example.com -m GET -d 10 -r 1000 -t 2000
```
### 2. JSON config file ### 2. JSON config file
You can find an example config structure in the [config.json](https://github.com/aykhans/dodo/blob/main/config.json) file: You can find an example config structure in the [config.json](https://github.com/aykhans/dodo/blob/main/config.json) file:
@ -69,6 +82,10 @@ Send 1000 GET requests to https://example.com with 5 parallel dodos (threads) an
```sh ```sh
dodo -c /path/config.json dodo -c /path/config.json
``` ```
With Docker:
```sh
docker run --rm -v ./path/config.json:/dodo/config.json -i aykhans/dodo
```
### 3. Both (CLI & JSON) ### 3. Both (CLI & JSON)
Override the config file arguments with CLI arguments: Override the config file arguments with CLI arguments:
@ -76,6 +93,10 @@ Override the config file arguments with CLI arguments:
```sh ```sh
dodo -c /path/config.json -u https://example.com -m GET -d 10 -r 1000 -t 2000 dodo -c /path/config.json -u https://example.com -m GET -d 10 -r 1000 -t 2000
``` ```
With Docker:
```sh
docker run --rm -v ./path/config.json:/dodo/config.json -i aykhans/dodo -u https://example.com -m GET -d 10 -r 1000 -t 2000
```
## CLI and JSON Config Parameters ## CLI and JSON Config Parameters
| Parameter | JSON config file | CLI Flag | CLI Short Flag | Type | Description | Default | | Parameter | JSON config file | CLI Flag | CLI Short Flag | Type | Description | Default |
@ -94,4 +115,3 @@ dodo -c /path/config.json -u https://example.com -m GET -d 10 -r 1000 -t 2000
## Examples ## Examples
![dodo_example](https://raw.githubusercontent.com/aykhans/dodo/main/assets/dodo-example.gif) ![dodo_example](https://raw.githubusercontent.com/aykhans/dodo/main/assets/dodo-example.gif)