From 4bf71e041fc3854ff652b7a40368e4485519e481 Mon Sep 17 00:00:00 2001 From: Aldo D'Aquino Date: Fri, 25 Jan 2019 11:26:36 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 756ad1d..491f123 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ To redirect the http traffic to https use `app.redirect()`. You can also serve static files with `app.serve(path)` -### [Optional/Linux] Install and trust the certificate -After `npm install` will run a script that tries to install and validate automatically the certificate. -**Actually works only on MacOS.** +### [Optional] Install and trust the certificate +**If you are not on MacOS or Ubuntu, you should follow this instructions.** -However, this script is in beta and provided as-is, so there isn't any guarantee that will work. +After `npm install` will run a script that tries to install and validate automatically the certificate. +However, this script is in beta and provided as-is, so there isn't any guarantee that will work. For that reason you can also install the certificate manually, as follows. If you decide to not install it, it's fine, the package still work. @@ -61,6 +61,15 @@ menu and select the file. Then double-click on the certificate and select always Depending on your Linux distribution, you can use `trust`, `update-ca-certificates` or another command to mark the generated root certificate as trusted. +#### TL;DR +Looking for something easier? Take a look to [mkcert](https://github.com/FiloSottile/mkcert) (requires Go). + +Install it, then move into the https-localhost folder and run: +``` +mkcert -install +mkcert -cert-file cert/localhost.crt -key-file cert/localhost.key localhost +``` + ### License [AGPL-3.0](LICENSE)