From 31686615f319e7cf2ac6f0fe0c480e185d8e4fee Mon Sep 17 00:00:00 2001 From: Carlos <28845529+mesacarlos@users.noreply.github.com> Date: Mon, 12 Aug 2019 03:39:19 +0200 Subject: [PATCH] README fix --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b671fac..5726758 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,21 @@ Dont worry about privacy: all data is stored in your browser offline and your PC 1. Download plugin from [Releases](https://github.com/mesacarlos/WebConsole/releases) 2. Open and close your server to generate the config.yml file and open it. You will see something like the following: -> useSSL: false -> StoreType: JKS -> KeyStore: plugins/WebConsole/keystore.jks -> StorePassword: storepassword -> KeyPassword: keypassword -> host: localhost -> port: 8080 -> password: yourPasswordGoesHere +> useSSL: false +> StoreType: JKS +> KeyStore: plugins/WebConsole/keystore.jks +> StorePassword: storepassword +> KeyPassword: keypassword +> host: localhost +> port: 8080 +> password: yourPasswordGoesHere -Fill `host`, `port` and `password` values. They are the IP you server run at, port where WebSockets will run and and login password, respectively. Password will be asked every time you connect to your server. +Fill `host`, `port` and `password` values. They are the IP you server is running at, port where WebSockets will run and login password, respectively. Password will be asked every time you connect to your server. #### SSL Configuration -If you want to use WebSockets Secure (A encrypted connection between Client and Server instead of sending plaintext) you need to enable it replacing `useSSL: false` to `useSSL: true` and generating your keystore.jks. You can achieve this by generating a selfsigned certificate or using a valid one, like a Let's Encrypt certificate. +If you want to use WebSockets Secure (An encrypted connection between Client and Server instead of sending plaintext) you need to enable it replacing `useSSL: false` to `useSSL: true` in your config.yml and generating your keystore.jks. You can achieve this by generating a selfsigned certificate or using a valid one, like a Let's Encrypt certificate. ##### Selfsigned certificate @@ -39,11 +39,12 @@ Remember to replace required values (the bold ones), so final command looks like > keytool -genkey -keyalg RSA -validity 3650 -keystore "keystore.jks" -storepass "myVerySecurePaSSword" -keypass "aVerySecurePaSSw0rdAgain" -alias "default" -dname "CN=127.0.0.1, OU=WebConsoleDevelopers, O=WebConsole, L=Madrid, S=Madrid, C=Spain" -Then, to enable connections from your browser remember to first navigate to https://localhost:8080/ (change port if you changed it before at config.yml). This is required in order to allow your browser connections to servers using your own selfsigned certificate. If you donīt follow this step, you wonīt be able to connect to your WebSockets Server. +Then, to enable connections from your browser remember to first navigate to https://localhost:8080/ (change port if you changed it before at config.yml) and skip the security warning (Click on connect anyway). This is required in order to allow your browser to connect to servers using your own selfsigned certificate. If you donīt follow this step, your browser will block connections to your WebSockets Server. + ##### Let's Encrypt certificate (or any PEM certificates) -WebConsole does not support PEM certificates, so you will need to convert it to create your keystore.jks file. Follow the steps mentioned in [this guide](https://gist.github.com/xkr47/920ffe94f6a4c171ee59): +WebConsole does not support PEM certificates, so you will need to convert it to create your keystore.jks file. Follow the steps mentioned in [this guide](https://gist.github.com/xkr47/920ffe94f6a4c171ee59), also explained here: 1. Convert certificate chain + private key to the PKCS#12 file format. You will be asked for a password: Remember it as it will be the StorePassword required in your config.yml > openssl pkcs12 -export -out keystore.pkcs12 -in fullchain.pem -inkey privkey.pem