Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Bozarth <[email protected]>
  • Loading branch information
ajbozarth committed Sep 25, 2024
1 parent f252950 commit 3a2cc84
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions curl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This directory contains a Dockerfile that builds `curl` using OpenSSL v3 using t
## More details

The Dockerfile
- obtains all source code required for building the quantum-safe crypto (QSC) algorithms, the QSC-enabled oqs-provider, curl (v.7.87.0) and the latest OpenSSL (master) code
- obtains all source code required for building the quantum-safe crypto (QSC) algorithms, the QSC-enabled oqs-provider, curl, and OpenSSL
- builds all libraries and applications
- creates OQS-enabled certificate files for a mini-root certificate authority (CA)
- creates an OQS-enabled server certificate for running a `localhost` QSC-TLS server
Expand Down Expand Up @@ -49,14 +49,17 @@ Information how to use the image is [available in the separate file USAGE.md](US

The Dockerfile provided allows for significant customization of the image built:

### OPENSSL_TAG

Tag of `openssl` release to be used.

### LIBOQS_TAG

Tag of `liboqs` release to be used. Default "main".
Tag of `liboqs` release to be used.

### OQSPROVIDER_TAG

Tag of `oqsprovider` release to be used. Default "main".
Tag of `oqsprovider` release to be used.

### LIBOQS_BUILD_DEFINES

Expand Down Expand Up @@ -94,3 +97,6 @@ Allow setting parameters to `make` operation, e.g., '-j nnn' where nnn defines t

The default is conservative and known not to overload normal machines. If one has a very powerful (many cores, >64GB RAM) machine, passing larger numbers (or only '-j' for maximum parallelism) speeds up building considerably.

### ALPINE_VERSION

The version of the `alpine` docker image to to be used.

0 comments on commit 3a2cc84

Please sign in to comment.