Skip to content

Commit

Permalink
Blurb on dirty runs
Browse files Browse the repository at this point in the history
  • Loading branch information
kegsay committed Jan 10, 2024
1 parent f52fdec commit dc6271f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Complement-Crypto Configuration
Complement-Crypto is configured exclusively through the use of environment variables. These variables are described below. Additional environment variables can be used, and are outlined at https://github.com/matrix-org/complement/blob/main/ENVIRONMENT.md
Complement-Crypto always runs in dirty mode (homeservers exist for the entire duration of the test suite) for performance reasons.

#### `COMPLEMENT_CRYPTO_TCPDUMP`
If 1, automatically attempts to run `tcpdump` when the containers are running. Stops dumping when tests complete. This will probably require you to run `go test` with `sudo -E`. The `.pcap` file is written to `tests/test.pcap`.
Expand Down
1 change: 1 addition & 0 deletions cmd/gendoc/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ func main() {
"",
"## Complement-Crypto Configuration",
"Complement-Crypto is configured exclusively through the use of environment variables. These variables are described below. Additional environment variables can be used, and are outlined at https://github.com/matrix-org/complement/blob/main/ENVIRONMENT.md ",
"Complement-Crypto always runs in dirty mode (homeservers exist for the entire duration of the test suite) for performance reasons.",
}
for _, vd := range varDocs {
mdFileLines = append(mdFileLines, fmt.Sprintf("\n#### `%v`", vd.Name))
Expand Down

0 comments on commit dc6271f

Please sign in to comment.