RemoteBukkit
RemoteBukkit
Plugin v4.0.0 - GUI v2.0.0 - Console v2.0.0
General
RemoteBukkit allows admins to, with the help of a plugin, remotely use the server's console. You do this by running a client on you computer and you provide this client with the hostname and port on which the RemoteBukkit plugin's server is running. Of course you will also need to provide the client with the server's username and password (set up in the plugin config file) for security.
So, provided the server has the RemoteBukkit plugin installed, admins can remotely use the Bukkit Console to control the server and execute Bukkit console commands server side.
RemoteBukkit does support multiple, simultaneous, connected clients.
News
Major Plugin Update v4.0.0
The latest plugin release (v4.0.0) adds support for CB v1.7.2.
Major Plugin Update v3.0.0
The latest plugin release (v3.0.0) adds support for multiple users.
Minor Plugin Update v2.5.0
The latest plugin release (v2.5.0) adds a number of highly requested features as well as a fix for a critical exploit.
Use
Plugin
Simply place the plugin in the standard Bukkit plugin directory and it will automatically generate its configuration the next time the server is run. The config file format is very simple, but offers several flexible options. The defaults are:
port: 25564 verbose: true logsize: 500 users: - user: username pass: password
All avaliable options and their descriptions are listed below.
Option | Default | Description |
---|---|---|
port | 25564 | The port on which the RemoteBukkit server will listen (this MUST be different to the Bukkit server's port number) |
verbose | true | Whether or not RemoteBukkit will produce verbose logging information (in the form "client X dispatched command Y"). |
logsize | 500 | The maximum number of log lines to send to a client upon successful connection. |
users | (list) | A list of the users which are permitted to connect to the RemoteBukkit server. The syntax for defining multiple user entries can be found in the example below. |
A more complex example configuration file can be found below (for demonstration purposes).
port: 6001 verbose: false logsize: 12 users: - user: escortkeel pass: secretpassword - user: bukkitserver pass: thepassword - user: minecraft pass: server
GUI Client
RemoteBukkit offers a very simple and easy to use GUI client which you can use to connect to the plugin. Just double click on the GUI's jarfile to run it. The GUI features a self-explanatory interface where you supply the hostname, port, username and password of the RemoteBukkit server.
Run the GUI with no arguments to open the Login Dialog. Run the GUI with the following arguments and it will attempt to use the supplied parameters to login automatically:
Use: [hostname:port] [user] [pass]
Switches
--help
- Prints this help message.
Console Client
If you prefer to use a console-based application to connect to the RemoteBukkit plugin you can too! The console argument syntax is very simple but the program but will print help information if you supply no/the wrong number of/invalid arguments:
Use: [hostname:port] [user] [pass] <switches>
Switches
--help
- Prints the help message.--nolog
- Instructs the server not to send any log information to the client.--exec <command>
- Sends <command> to the server and then terminates. Useful for scripts. Make sure that you surround commands containing spaces in inverted commas (e.g. "say Hello, World!").
Telnet Client (advanced)
RemoteBukkit also supports telnet connections. Just connect to the normal server port as you would with the console or GUI clients and then supply the server's username and then password on separate lines, followed by a third, blank line.
e.g.
$ telnet [hostname:ip] [user] [pass] [blank line]
Download
The latest plugin build can be downloaded here.
The latest GUI build can be downloaded here.
The latest console build can be downloaded here.
Latest Changes
Plugin v3.0.0
- Added multi-user support!
GUI v2.0.0
- Updated protocol version
Console v2.0.0
- Added
--nolog
switch - Updated protocol version
Planned Features
A standalone GUICompleted!Integration with BukkitGUI - With the help of BertwareCompleted!- Integration with RunBukkit - Another GUI for Bukkit which is not on BukkitDev (yet!)
How Can I Help?
This plugin is developed solely by me in my free time so:
- If you are a developer would like to contribute to this project, or any of my other projects, please PM me or email me at [email protected].
- If you are a not developer but would still like to contribute somehow, please consider donating. Donations are highly valued and much appreciated.
About
Developer: Keeley Hoek (escortkeel)
@krone6
Hi krone6! :D
I've seen that behavior occur when you specify the port number of the Bukkit server (e.g. 25565) instead of the RemoteBukkit port number (e.g. 25564).
~
Keeley :)hello, would this plugin allow me to execute commands through cron? say I want to reload the server on an hourly basis using crontab for the hour part, would there be a way to give a cron a command to execute which would then execute the command in the bukkit console? thanks!
When I use the GUI to connect the orange bar completes and fills up. A black box then appears and that's it. No text either. What could cause this and anything I can do to fix it so i can view my console remotely?
@supermegacraft14
Hi SyperMegaCraft14!
Right, so I'll just cut to the chase, apparently the RemoteBukkit plugin decided that it didn't like your client and that it would disconnect. :P
Seriously though, that's really weird!
I've seen this happen before when you specify the port number of the Bukkit server to the client program, instead of the plugin's port. e.g. The server is running on port 25565 and the plugin is set up to run on port 25564 (because they have to be different) and you tell the GUI to try to connect to port 25565 of the server. Then stuff starts to stuff up as the GUI client tries to talk to the Bukkit server like it is actually the plugin, and Bukkit freaks out and just disconnects from the client, printing "blah.blah.blah.blah:blah lost connection".
Just a thought.
~
Keeley :D@firebunny36
Hi firebunny36! :D
I'm terribly sorry that I've been inactive for so long now, but I'm free for the foreseeable future so I really hope that doesn't happen again.
In other news a new update will be going up in a few hours containing several bugfixes including the one that fixes the exception that you reported. Thanks for the report!
~
Keeley :D@supermegacraft14
SyperMegaCraft14,
Hi! :D I'll have a look at that this afternoon, at about the same time the new update goes up. Expect a reply from me soon. Again, I'm really sorry for being inactive recently.
~
Keeley :D@Sypher40
Hi Sypher40!
What exactly is you problem? Does the console not work for you? Are you running the console app via a terminal? If so, I'll be able to help if you reply to this comment with the exact command syntax that you are using to start the console form the command line.
~
Keeley :DThis is working great for me, but the console thing is not working.
I set up the port forwarding and the user and password but my GUI gives me this message. "Connection to server lost: software closed connection abort: recv failed". My actual server console says [My public IP and some random port] lost connection. I port forwarded it to a TCP port on port 25564. It wont work but I would like to use this could you help me?
on 1.4.2
@firebunny36
Hi firebunny36! :D
Would you mind pasting in the exact exception? The one Conlinz25 reported looks as though it was thrown in an old version of the plugin. I'd be happy to follow it up ASAP.
Thanks a bunch,
Keeley :D
I'm getting the exact same error as Colinz25 below. First time or two I connect, it's no issue; I can use commands and the text streams fine. Then that error comes and no sent commands get processed. Connect again and no incoming text is received either.
This is with large gaps in between disconnecting and connecting so not an issue with spamming the threads.
Hey there. I tried changing my username and password like you said, but when I reload the plugin, it changes them back to default. Any ideas?
@dalatorabvon21
Hi dalatorabvon21! :D
Sure, no problem! If you're planning on using the default port of 25564 as your RemoteBukkit port (which is suitable for almost every situation), your going to want to port forward TCP port 25564.
If you need any more help, feel free to provide details of your router (such as model number) and I'd be happy to assist.
Thanks for using RemoteBukkit,
Keeley :D
Hey there escortkeel, I really like the concept of your plugin, and how lightweight it is, but I'm having some trouble with the port-forwarding. Can you provide a little more information regarding this?
Some example questions might be, what protocol do I use? Single Port Forward or something else? Can I use a different port?
Please help, I would really like this to work for me =/
@jeep70
It's in the works! :D
@Colinz25
Hi Conlinz25,
Are you using the latest version of the plugin? We're up to version 1.4.2.
Thanks,
Keeley :D
You should add FTP :D
I'm getting this in my console / server log every now and then:
Haven't noticed any problems immediately after the error.
@escortkeel
well the GUI opens but whenever I try to use a command like 'stop' it just does nothing. When I do connect to it my server log says [Info]/ (my public ip) lost connection. So I guess it still isn't working for me.
@supermegacraft14
@Preatomicmatt
Hi! Sorry that I haven't replied recently, I've been really busy!
I've just put out a new version of plugin and GUI which gives a reason for the disconnect. Try running that and post your results up here.
~
Keeley@supermegacraft14
That happens to me too, it never connects, and never has