From 3a5703725f6e48c8914cac90e36516f283f50d78 Mon Sep 17 00:00:00 2001 From: Alex Bozarth Date: Wed, 25 Sep 2024 15:36:07 -0500 Subject: [PATCH] Update README --- curl/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/curl/README.md b/curl/README.md index 426c743a..ba41cac2 100644 --- a/curl/README.md +++ b/curl/README.md @@ -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 @@ -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 @@ -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.