@@ -28,36 +28,36 @@ This framework has been developed as part of the _"A Bug's Life: Analyzing the L
28
28
BugHog is compatible with UNIX systems running Docker, including WSL on Windows.
29
29
Follow these steps to get started:
30
30
31
- 1 . ** Clone this repository:**
31
+ ### 1. Clone this repository:
32
32
33
33
```bash
34
34
git clone https://github.com/DistriNet/BugHog
35
35
cd BugHog
36
36
```
37
37
38
- 2. ** Obtain images:**
38
+ ### 2. Obtain images:
39
39
40
- You will need at least 5 GB of disk space.
41
- There are two options available to obtain the BugHog images, and you can switch between them by executing the appropriate command.
40
+ You will need at least 5 GB of disk space.
41
+ There are two options available to obtain the BugHog images, and you can switch between them by executing the appropriate command.
42
42
43
- *** Option A:** Pulling (fastest)*
43
+ #### Option A: Pulling (fastest)
44
44
45
- Use the following command to pull the necessary Docker images:
46
- ` ` ` bash
47
- docker compose pull core worker nginx
48
- ` ` `
45
+ Use the following command to pull the necessary Docker images:
46
+ ``` bash
47
+ docker compose pull core worker nginx
48
+ ```
49
49
50
- > [! NOTE]
51
- > If you prefer to use a version other than the latest, simply modify the ` BUGHOG_VERSION` and / or ` BUGHOG_WEB_VERSION` variables accordingly.
50
+ > [ !NOTE]
51
+ > If you prefer to use a version other than the latest, simply modify the ` BUGHOG_VERSION ` and / or ` BUGHOG_WEB_VERSION ` variables accordingly.
52
52
53
- *** Option B:** Building*
53
+ #### Option B: Building
54
54
55
- Use the following commands to build the Docker images yourself, for instance after you made changes to the source code:
56
- ` ` ` bash
57
- docker compose build core worker nginx
58
- ` ` `
59
- > [! NOTE]
60
- > For reference, building takes about 4 minutes on a machine with 8 CPU cores and 8 GB of RAM.
55
+ Use the following commands to build the Docker images yourself, for instance after you made changes to the source code:
56
+ ``` bash
57
+ docker compose build core worker nginx
58
+ ```
59
+ > [ !NOTE]
60
+ > For reference, building takes about 4 minutes on a machine with 8 CPU cores and 8 GB of RAM.
61
61
62
62
63
63
## Usage
0 commit comments