Wiki of Konsole EN
This is the official wiki of Konsole, EN version
this part is not completely built yet, but you can see some features.
Plugin advanced information
Here you can see advanced information about several features of the plugin.
Config.yml explanations
This config file is by default correctly configured. Take care if you change any parameters to see if that don't impact the security of your server (e.g : too simple password, or unsafe number try auth.) I'm not responsible of any server hack cause to bad parameter.
| key | type | explanation |
|---|---|---|
| lang | String | Language of Konsole. You can import your own language file and set it. All available language are located on Konsole/lang/<lang>.yml |
| port | Integer | The port used by Konsole. It must be between 1 to 65535 |
| save_log_user | Boolean | Activate personal Konsole logs (more visibility) |
| nb_max_try_connect | Integer | Number try before ban an IP when Authenticating (use to prevent bruteforce hack) |
| nb_second_apologize | Integer | Number second before reset ip try anthenticating |
| nb_seconds_ban | Integer | Number seconds before a banned person can try reconnecting again. If your server is shutting down, that will reset all banned ip. |
| notify_update_avaiable | Boolean | Activate the auto-update-checker Very recommended to keep that true in order to keep the plugin safe and secured |
| users | UserType | All registred users. See how to add an user under this table. |
UserType
| key | type | explanation |
|---|---|---|
| canSendCommand | Boolean | If the user can only see the console or if he can send command too |
| password | String | The password. The default password is automatically strongly generated by a secureRandom in java. It's a safe password. |
About Update-Checker and Metrics
This project use a homemade (for the moment) auto-updater that will check at rss feed of Konsole Project files if a new server file is available. This project use Metrics, which will send some information about your server on a public statistics server. You are free to see what that send at the Konsole metrics page. This information will be collected in order to know who use this plugin and in what context. You are free to disable this feature by editing your Metrics config (in your folder plugin/PluginMetrics).
Development information
This part is reserved for experimented and curious users . It's completely useless for simple user who just want to use the plugin.
Source Code
The source code is avaiable on GitTub: Here !
Please don't break the License.
This sourcecode is updated each time a new version is avaiable. I will not put the developpement code if the version is not finished.
The Konsole protocol
Konsole use his own protocol to communicate with a client. The protocol works with keywords sent by the client and message number received from the server.
Message number meaning
The server answer to the client by sending messages which mean something quite abstract. In fact, the client determine by this previously sent request what it's mean.
Here you have an exhaustive list of all message number that the server can send to the client :
- 1- Welcome message (successfully connected)
- 2- Successfully received what you sent
- 3- You request is not complete (missing parameters)
- 4- You sent wrong parameters
- 5- Action successfully finished
- 6- Intern Error
- 7- A console message (to display on the client remote console interface)
- 8- Information (like CanSendCommand=true, try=1/5 etc...)
- 9- Error from the client (user try send message without getting the Konsole)
- 10- Unknown command
Keywords
The client talk with the server by using keywords. Some keywords can be locked depending of the situation (e.g : you're not connected, so you can't use the keyword COMMAND to send commands over the console.). If you try to use not adapted situation keywords, the server will answer you a "10-" message type (see Message number meaning). All keywords must be on upper case.
Here you have an exhaustive list of all keywords that the client can send to the server :
Authentication situation
- USER send a username
- PASSWD send a password
- VALIDATE validate the user & password you previously sent
Authenticated situation
- GET get a Konsole
- COMMAND send a command to the console
- DISCONNECT disconnect you from the Konsole
Here you have a small homemade tutorial that will show you how to use the konsole plugin, without any client (you can click on the link below if the BukkitDev integration video fail.) It's for advanced users only and you need a java compiler to compile the program i create below. I do not recommend to connect to the plugin by this way because this plugin is created to make an easier way to remote a console. The client is made in order to make easy remote craftbukkit console.
If it doesn't work : https://www.youtube.com/watch?v=QBUr2kQ7Lag
JAVA file you need to create the programm :
Main.java : http://pastebin.com/96aU48VP
Listener.java : http://pastebin.com/mzZ00JtA
Comments