You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-5Lines changed: 18 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,14 +63,14 @@ Follow these steps to get started:
63
63
64
64
Launch BugHog using the following command:
65
65
```bash
66
-
docker compose up
66
+
docker compose up -d
67
67
```
68
68
69
69
> :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.
70
70
> To avoid this, explicitly pass on this variable: `sudo PWD=$PWD docker compose up`.
71
71
72
72
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.
74
74
75
75
BugHog can be stopped through:
76
76
```bash
@@ -98,7 +98,7 @@ Be sure to restart the BugHog framework when you add a new experiment:
98
98
99
99
```bash
100
100
docker compose down
101
-
docker compose up
101
+
docker compose up -d
102
102
```
103
103
104
104
## Development
@@ -114,13 +114,26 @@ For debugging the core application, consider using the VS Code dev container.
114
114
You can utilize the configuration in [.devcontainer](.devcontainer) for this.
115
115
116
116
117
-
## Additional help
117
+
## Contact
118
118
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).
120
122
121
123
122
124
## Troubleshooting
123
125
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
+
124
137
### WSL on Windows
125
138
126
139
- 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