|
|
|
|
@ -20,55 +20,55 @@ Don't worry about privacy or security: all data is stored in your browser locall
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Plugin installation
|
|
|
|
|
## Step 1. Plugin installation
|
|
|
|
|
|
|
|
|
|
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: 0.0.0.0
|
|
|
|
|
port: 8080
|
|
|
|
|
language: en
|
|
|
|
|
passwords:
|
|
|
|
|
admin:
|
|
|
|
|
user1:
|
|
|
|
|
password: mySecurePassword
|
|
|
|
|
commandWhitelist:
|
|
|
|
|
enabled: true
|
|
|
|
|
commandWhitelistActsAsBlacklist: false
|
|
|
|
|
whitelist:
|
|
|
|
|
- whisper
|
|
|
|
|
- gamemode survival
|
|
|
|
|
viewer: {}
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
useSSL: false
|
|
|
|
|
StoreType: JKS
|
|
|
|
|
KeyStore: plugins/WebConsole/keystore.jks
|
|
|
|
|
StorePassword: storepassword
|
|
|
|
|
KeyPassword: keypassword
|
|
|
|
|
host: 0.0.0.0
|
|
|
|
|
port: 8080
|
|
|
|
|
language: en
|
|
|
|
|
passwords:
|
|
|
|
|
admin:
|
|
|
|
|
user1:
|
|
|
|
|
password: mySecurePassword
|
|
|
|
|
commandWhitelist:
|
|
|
|
|
enabled: true
|
|
|
|
|
commandWhitelistActsAsBlacklist: false
|
|
|
|
|
whitelist:
|
|
|
|
|
- whisper
|
|
|
|
|
- gamemode survival
|
|
|
|
|
viewer: {}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 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 don't have a public IP assigned to your device) type your private IP, it is probably 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 don't 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`), Japanese (`ja`) Korean (`ko`), Polskie (`pl`), Portuguese (`pt`), Russian (`ru`) and Turkish (`tr`). **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:
|
|
|
|
|
Since 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 view-only user, remove the `{}` after `viewer: ` and type below a row like `user: password` replacing user with your desired username and password with your password.
|
|
|
|
|
- You can create as many admins or viewers as needed.
|
|
|
|
|
- For all your admin users, you can enable a whitelist of commands under the commandWhitelist section of your user.
|
|
|
|
|
|
|
|
|
|
The rest of the fields are used for SSL configuration. You can learn how to activate SSL [here](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.
|
|
|
|
|
The rest of the fields are used for SSL configuration. You can learn how to activate SSL [here](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 security restrictions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Using web interface
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
## Step 2. Using web interface
|
|
|
|
|
You can either download and host your own client or use it from my server.
|
|
|
|
|
- To host your own client, download client.zip from [Releases](https://github.com/mesacarlos/WebConsole/releases) and drop these files in a web server, like Apache, NGINX, or other of your liking.
|
|
|
|
|
- If you don't want to deploy your own client, you can also use my [WebConsole Hosted Clients](https://mesacarlos.es/webconsole/) webpage, where all versions of the client are available.
|
|
|
|
|
|
|
|
|
|
## Check connected WebConsole clients
|
|
|
|
|
Since v1.3, you can use /WebConsole command to view how many clients are connected and their IP address. This is the only Minecraft command provided by this plugin. This command requires you to have `webconsole.webconsole` permission to execute it.
|
|
|
|
|
|
Carlos