Uplandustries/WebConsole-Client-v2.4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README and minor changes to client

Browse Source
This commit is contained in:
Carlos 2019-08-24 11:47:22 +02:00
parent f3ec1c5149
commit cb9027c42a
3 changed files with 25 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -4,12 +4,20 @@ WebConsole is a Spigot plugin for Minecraft 1.8-1.14 that enables you to view yo
Dont worry about privacy or security: all data is stored in your browser offline and your PC will connect directly to your minecraft server. No intermediary web servers, just you and your MC server.
#### Additional features:
* Command history: Use up/down arrow keys to browse the command history, like in the real console.
* Colors supported, for both Windows and Linux hosts. (Colors are represented different in each platform).
* Real-time connected players, machine CPU and server RAM usage information.
* English, Spanish and Russian (thanks to Stashenko) supported.
* Free and updated regularly.
* And many more!
![Screenshot](https://i.imgur.com/sN1sYju.png)
## Plugin installation
1. Download plugin from [Releases](https://github.com/mesacarlos/WebConsole/releases)
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
@ -23,49 +31,19 @@ Dont worry about privacy or security: all data is stored in your browser offline
Fill `host`, `port` and `password` values. They are, respectively, your server IP, a port where to run this plugin (cannot be the port you are using for Minecraft) and the login password. Password will be asked every time you connect to WebConsole.
#### SSL Configuration
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
The fast way, but only reccomended for testing purposes. Generate your certificate by running this command on your machine
> keytool -genkey -keyalg RSA -validity 3650 -keystore "keystore.jks" -storepass "**storepassword**" -keypass "**keypassword**" -alias "default" -dname "CN=127.0.0.1, OU=**MyOrgUnit**, O=**MyOrg**, L=**MyCity**, S=**MyRegion**, C=**MyCountry**"
Remember to replace required values (the bold ones), so final command looks like this:
> 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) 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), 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
2. convert PKCS#12 file into Java keystore format. You will be asked for another password. This time you are typing the KeyPassword, also required in config.yml
> keytool -importkeystore -srckeystore keystore.pkcs12 -srcstoretype PKCS12 -destkeystore keystore.jks
3. PKCS#12 file can be deleted
> rm keystore.pkcs12
4. Copy keystore.jks to your plugin folder (plugins/WebConsole/keystore.jks)
You can see a tutorial on how to activate SSL [in this link](https://github.com/mesacarlos/WebConsole/wiki/SSL-Configuration). SSL **is not** required for WebConsole to work, you can still use it without encription.
## Using web interface
1. Download web interface (client.zip) from [Releases](https://github.com/mesacarlos/WebConsole/releases)
1. Download web interface (client.zip) from [Releases](https://github.com/mesacarlos/WebConsole/releases).
2. If you want, you can host it in a web server, or use it offline. That's up to you.
3. To start adding servers, click on `Your servers`, and then `Add server`. Fill Server name, IP and WebConsole port (the one you placed into config.yml before), and you are ready to go. You will be prompted for password when connecting.
## Technical information
You can find how client and server comunicate [here](https://github.com/mesacarlos/WebConsole/wiki/WebSocket-commands-and-responses)
You can find how client and server comunicate [here](https://github.com/mesacarlos/WebConsole/wiki/WebSocket-commands-and-responses).
## Bugs, suggestions or problems configuring WebConsole?
You can open an issue on [GitHub](https://github.com/mesacarlos/WebConsole/issues) or ask me at [Spigot forums](https://www.spigotmc.org/threads/webconsole.390291/).

4
client/index.html
View File

@ -81,7 +81,7 @@
<div class="col-sm-3 mb-2">
<div class="card">
<div class="card-body">
<h5 class="card-title">CPU</h5>
<h5 class="card-title" id="cpu_title">CPU</h5>
<p class="card-text" id="cpuInfo">0%</p>
<div class="progress flat-progressbar">
<div class="progress-bar progress-bar-striped progress-bar-animated" role="progressbar" style="width: 0%;" id="CpuProgressBar"></div>
@ -92,7 +92,7 @@
<div class="col-sm-3 mb-2">
<div class="card">
<div class="card-body">
<h5 class="card-title">RAM</h5>
<h5 class="card-title" id="ram_title">RAM</h5>
<p class="card-text"><span id="usedRam">0</span> MB / <span id="totalRam">0</span> MB</p>
<div class="progress flat-progressbar">
<div class="progress-bar progress-bar-striped progress-bar-animated" role="progressbar" style="width: 0%;" id="RamProgressBar"></div>

10
client/scripts/WebConsoleLanguage.js
View File

@ -7,7 +7,7 @@
function setLanguage(locale){
//Save to persistence
persistenceManager.setLanguage(locale);
//Set dialog phrases
//Set locale phrases
switch(locale){
case "en_US":
lang = {
@ -33,6 +33,8 @@ function setLanguage(locale){
"disconnectionModalDescription": "Connection was lost with the server you were connected to, probably caused by a server stop. Moved back to welcome screen.",
"disconnectionModalCloseButton": "Close",
"players_online": "Players Online",
"cpu_title": "CPU",
"ram_title": "RAM",
"deleteServerButton": "Delete server",
"sendCommandButton": "Send"
}
@ -61,6 +63,8 @@ function setLanguage(locale){
"disconnectionModalDescription": "Se ha perdido la conexión con el servidor al que estabas conectado. Esto puede ser debido a que el servidor se ha cerrado. Se ha vuelto a la ventana principal.",
"disconnectionModalCloseButton": "Cerrar",
"players_online": "Jugadores en línea",
"cpu_title": "CPU",
"ram_title": "RAM",
"deleteServerButton": "Borrar servidor",
"sendCommandButton": "Enviar"
}
@ -88,6 +92,8 @@ function setLanguage(locale){
"disconnectionModalLongTitle": "Отключение!",
"disconnectionModalDescription": "Соединение с сервером, к которому вы подключены, потеряно.",
"players_online": "Игроки",
"cpu_title": "CPU",
"ram_title": "RAM",
"deleteServerButton": "Удалить сервер",
"sendCommandButton": "Отправить"
}
@ -118,6 +124,8 @@ function setLanguage(locale){
document.getElementById("disconnectionModalDescription").textContent = lang.disconnectionModalDescription;
document.getElementById("disconnectionModalCloseButton").textContent = lang.disconnectionModalCloseButton;
document.getElementById("players_online").textContent = lang.players_online;
document.getElementById("cpu_title").textContent = lang.cpu_title;
document.getElementById("ram_title").textContent = lang.ram_title;
document.getElementById("deleteServerButton").textContent = lang.deleteServerButton;
document.getElementById("sendCommandButton").textContent = lang.sendCommandButton;
}