diff --git a/README.md b/README.md index 4947a64..6283782 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ [](https://github.com/mesacarlos/WebConsole/releases/latest)  -WebConsole is a Spigot plugin for Minecraft 1.8-1.16+ that enables you to view your server console and manage your server from anywhere. It creates a WebSocket server in the background used by the web interface to send commands, receive your console log and manage your server. +WebConsole is a Spigot plugin for Minecraft 1.8-1.16+ that allows you to view your server console and manage your server from anywhere. It creates a WebSocket server in the background used by the web interface to send commands, receive your console log and manage your server. 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: -* Multiuser system and View-only user mode: Users with the role "Viewer" can only read console, CPU and RAM usage. Users with role "Admin" can also run commands on the server. Useful if you want your friends to watch the server console but deny them from typing commands and ruining your server. +* Multiuser system and View-only user mode: You can create multiple users and set their role to "Admin" or "Viewer". Users with the role "Viewer" can only read console, CPU and RAM usage. Users with role "Admin" can also run commands on the server. Useful if you want your friends to watch the server console but deny them from typing commands and ruining your server. * 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. @@ -42,16 +42,16 @@ Dont worry about privacy or security: all data is stored in your browser offline A explanation of the `host`, `port`, `language` and `passwords` fields follows: -`host`: Leaving it as 0.0.0.0 will do the trick. If you want to listen to a network interface exclusively: If you are in a VPS or dedicated server (or you have a full public IP allocated for your device) type your public IP. If you are at your home (and you dont have a public IP assigned to your device) type your private IP, it should be something like 192.168.xx.xx. +`host`: Leaving it as 0.0.0.0 will do the trick. If you experience issues , you can change this value to your device IP. If you are in a VPS or dedicated server (or you have a full public IP allocated for your device) type your public IP. If you are at your home (and you dont have a public IP assigned to your device) type your private IP, it is probably something like 192.168.xx.xx. `port`: A port where to run this plugin (cannot be the port you are using for Minecraft). You can modify `language` to view console and command messages in your preferred language. Valid languages are English (`en`), Spanish (`es`), Chinese (`zh`), Czech (`cs`), Deutsch (`de`), Dutch (`nl`), French (`fr`), Italian (`it`), Korean (`ko`), Portuguese (`pt`) and Russian (`ru`). **IMPORTANT: There is a known issue with Microsoft Windows cmd that shows weird characters when using a language different than English. If you are using Windows to host your server, check [this wiki page](https://github.com/mesacarlos/WebConsole/wiki/Show-local-characters-in-Windows-Console) to solve the problem**. From version 2.0 you can now create more than one user and set them as admin (Permission for both reading console and executing commands) or viewer (Permission for only reading console and CPU and RAM usage). This is configured using the `passwords` section: +- By default, a user called user1 with password mySecurePassword is created, please replace or remove it as it is only served as an example. - If you want to create a admin user, type below `admin:` a row like `user: password` replacing user with your desired username and password with your password. - You can create as many admins as you want repeating this step. -- By default, a user called user1 with password mySecurePassword is created, please replace or remove it as it is only served as an example. - If you want to create a view-only user, remove the `{}` after `viewer: ` and do the same process as for admin users below `viewer: `. You can also create as many viewers as needed. The rest of the fields are used for SSL configuration. 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, unless you are hosting your client in a HTTPS server, in this case is mandatory to enable SSL in all your servers due to web browsers restrictions. @@ -59,8 +59,8 @@ The rest of the fields are used for SSL configuration. You can see a tutorial on ## Using web interface -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. +1. You can download web interface (client.zip) from [Releases](https://github.com/mesacarlos/WebConsole/releases) or, if you prefer, you can use my [WebConsole Hosted Clients](https://mesacarlos.es/webconsole/) webpage. You can host the client in a web server, or use it offline. That's up to you. +2. Open index.html if you downloaded the client or click on the latest version if you are using my Hosted Clients website. 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. ## Check connected WebConsole clients diff --git a/client/index.html b/client/index.html index 1001f89..6bfa55f 100644 --- a/client/index.html +++ b/client/index.html @@ -218,8 +218,12 @@
-