From 0b0d92597951d5a5f7e485a828d9740d490a7794 Mon Sep 17 00:00:00 2001 From: Emii Tatsuo Date: Wed, 25 Nov 2020 15:44:20 -0500 Subject: [PATCH] Updated README to reflect automatic certificate generation --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b6a4b1f..a8cfcc6 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,13 @@ kochab = { git = "https://github.com/Alch-Emi/kochab.git" } # Generating a key & certificate -Run +By default, kochab enables the `certgen` feature, which will automatically generate a certificate for you. All you need to do is run the program once and follow the prompts printed to stdout. You can override this behavior by disabling the feature, or by using the methods in the `Builder`. + +If you want to generate a certificate manually, you can use the command: + ```sh mkdir cert && cd cert openssl req -x509 -nodes -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 ``` -and enter your domain name (e.g. "localhost" for testing) as Common Name (CN). - -Alternatively, if you want to include multiple domains add something like `-addext "subjectAltName = DNS:localhost, DNS:example.org"`. [northstar]: https://github.com/panicbit/northstar "Northstar GitHub"