Skip to content

Commit a93f958

Browse files
committed
Update README.md
1 parent 2149943 commit a93f958

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ Follow these steps to get started:
6363

6464
Launch BugHog using the following command:
6565
```bash
66-
docker compose up
66+
docker compose up -d
6767
```
6868

6969
> :warning: If you use `sudo` with this command, the `PWD` environment variable won't be passed to the BugHog containers, which is necessary for dynamically starting worker containers.
7070
> To avoid this, explicitly pass on this variable: `sudo PWD=$PWD docker compose up`.
7171
7272
Open your web browser and navigate to [http://localhost:5000](http://localhost:5000) to access the graphical interface.
73-
BugHog is started on a remote server, substitute 'localhost' with its IP address.
73+
If BugHog is started on a remote server, substitute 'localhost' with the appropriate IP address.
7474
7575
BugHog can be stopped through:
7676
```bash
@@ -98,7 +98,7 @@ Be sure to restart the BugHog framework when you add a new experiment:
9898

9999
```bash
100100
docker compose down
101-
docker compose up
101+
docker compose up -d
102102
```
103103

104104
## Development
@@ -114,13 +114,26 @@ For debugging the core application, consider using the VS Code dev container.
114114
You can utilize the configuration in [.devcontainer](.devcontainer) for this.
115115

116116

117-
## Additional help
117+
## Contact
118118

119-
Don't hesitate to open a [GitHub issue](https://github.com/DistriNet/BugHog/issues/new) if you come across a bug, want to suggest a feature, or have any questions!
119+
Don't hesitate to open a [GitHub issue](https://github.com/DistriNet/BugHog/issues/new) if you encounter a bug or want to suggest a feature!
120+
121+
For questions or collaboration, you can reach out to [Gertjan Franken](https://distrinet.cs.kuleuven.be/people/GertjanFranken).
120122
121123
122124
## Troubleshooting
123125
126+
If something isn't working as expected, check out the troubleshooting tips below.
127+
If you don't find a solution, don't hesitate to open a [GitHub issue](https://github.com/DistriNet/BugHog/issues/new).
128+
Feel free to include any relevant logs.
129+
130+
131+
### Consult the logs
132+
133+
- Try launching BugHog without the `-d` flag to see logging output in the terminal, which might provide more information about the issue.
134+
- For more detailed logs at the `DEBUG` level, check out the [logs](/logs) folder for all logging files.
135+
136+
124137
### WSL on Windows
125138

126139
- Ensure you clone the BugHog project to the WSL file system instead of the Windows file system, and launch it from there.

0 commit comments

Comments
 (0)