Skip to content

Commit 2cb36bf

Browse files
build: add documentation for ssl crypto provider feature flags
1 parent f61aeb4 commit 2cb36bf

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
with:
3333
tool: cargo-hack
3434
- name: Build
35-
run: cargo hack build --each-feature --keep-going
35+
run: cargo hack build --at-least-one-of ring,aws-lc-rs,ssl --feature-powerset --depth 2 --keep-going
3636

3737
test:
3838
name: Test
@@ -62,7 +62,7 @@ jobs:
6262
with:
6363
tool: cargo-hack
6464
- name: Tests
65-
run: cargo hack test --each-feature --clean-per-run
65+
run: cargo hack test --at-least-one-of ring,aws-lc-rs,ssl --feature-powerset --depth 2 --clean-per-run
6666

6767
fmt:
6868
name: Rustfmt check

docs/features/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,13 @@ Configuration is fetched in the following order:
3131
1. `DOCKER_AUTH_CONFIG` environment variable, unmarshalling the string value from its JSON representation and using it as the Docker config.
3232
2. `DOCKER_CONFIG` environment variable, as an alternative path to the directory containing Docker `config.json` file.
3333
3. else it will load the default Docker config file, which lives in the user's home, e.g. `~/.docker/config.json`.
34+
35+
## bollard, rustls and SSL Cryptography providers
36+
`testcontainers` uses [`bollard`](https://docs.rs/bollard/latest/bollard/) to interact with the Docker API.
37+
38+
`bollard` in turn has options provided by `rustls` to configure its SSL cryptography providers.
39+
40+
The `testcontainers` feature flags to control this are as follows:
41+
* `ring` - use `rustls` with `ring` as the cryptography provider (default)
42+
* `aws-lc-rs` - use `rustls` with `aws-lc-rs` as the cryptography provider
43+
* `ssl` - use `rustls` with a custom cryptography provider configuration - see [bollard](https://docs.rs/bollard/latest/bollard/#feature-flags) and [rustls](https://docs.rs/rustls/latest/rustls/#cryptography-providers) documentation for more.

0 commit comments

Comments
 (0)