Bukkit

Installation Guide

Before You Begin

For X-Ray Detective to work, it is assumed that:

• You have a functioning Minecraft server
• Your Minecraft server is running Logblock as your Logging Software. (Guardian not yet supported)
• Your Logging Software stores its information in a MySQL database. Flatfile is not supported.
• You have a webserver, which is PHP capable.

Download

Download the latest release of X-Ray Detective. All of the files will be contianed within a ZIP file.

Extract the files to a location on your computer so that you can upload the files to your web server.

Upload To Web Server

If your web server is hosted remotely or hosted by a third party provider, you will need to upload the X-Ray Detective script from your computer to your web server.

We assume you know how to use an FTP client to upload the X-Ray detective script to your web server.

Allow Writing To /config/ Directory

Make sure the /config/ directory can be written to. If the web server is running Unix/Linux, CHMOD the directory and its contents to 777.

If you're running a Windows server, right click the /config/ folder, go to the Security tab, and Edit the permissions, allowing the appropriate account to modify the folder. If you are using IIS, it may be 'IIS_IUSRS', or 'Users'.

Configure MySQL User Account

X-Ray Detective will be using a MySQL username and password to login to the MySQL database that contains your Logging Software.

You will still need to make sure that the account you will use to connect to the database has permission to access and modify the X-Ray Detective tables. The following permissions are required:

• SELECT
• INSERT
• UPDATE
• DELETE
• SHOW VIEW

The following permission may also be required in future versions:

• DROP
• ALTER
• TRIGGER
• LOCK TABLES

Setup

If your web server is NOT the same computer as your Minecraft server or the computer you are currently using, you may need to edit config_settings.php and add the IP of your computer to the Failsafe IPs list. This limits who can use the Setup script to modify X-Ray Detective's settings.

Run http://your_server_address/your_xray_directory/setup.php on your webserver from an internet browser to run the Setup script. It will guide you through the setup process. If you need additional clarification on any of the configuration values, please consult the Configuration page.

You will not be able to use the X-Ray Detective script until you complete all of the steps of the Setup successfully.

Done

Open http://your_server_address/your_xray_directory/xray.php from an internet browser to use X-Ray Detective.

You may want to learn how to interpret the information the X-Ray Detective provides you with before you decide to punish any of your users.

If your Authorization Mode is set to "username" and you receive the error "You are not authorized to view this page", then that no users were found on your Logging Software with your IP address. You need to login to your Minecraft server from the computer you are using for your Logging Software to update your IP. Alternatively, you can add your computer's IP address to the Failsafe IPs list, which will always give Administrator status to anyone who accesses the script from that IP.