/Echelon

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

Echelon 3

Echelon 3 is a smarter way to manage and moderate clients in a RCON server.

Note: I had deleted this source code but as I've been cleaning through my machine I had noticed it still with a .git folder. I thought I'd put it back onto GitHub. I might start working on this again in the future.

About

Echelon 3 is a complete overhaul of Echelon 2's outdated Design, UI, and UX. Echelon is a simple to use online application which allows system and server administrators to have faster methods of performing moderating tasks on a Rcon based, B3 supported, server.

Features

Echelon 3 currently has support for sixteen Rcon Games and provides features such as Client moderating, In-Game chat support, XLR Intergration, User Permissions, and a public ban list.

Current Version 3.0.0a1 : unstable

The current version of Echelon 3 is not fully tested and people should never use the code on a production server. Until the most important round of testing and security checks have complete, version 3.0.0a1 of Echelon 3 will not pass off as stable or secure. There is a lot of old code that still needs improving and the development team is working hard to complete the tool.

A detailed Change Log of the progress for Echelon 3 shows the small changes for the tool. Please note this is a developers changelog and is not indented for non-developers to fully understand.

All of the information below is subject to change and will likely move to a wiki page instead. The Wiki Pages intend to display information for all of the major changes in Echelon 3 and progess on the development of the tool.

Requirements

  • Webserver (Apache, Nginx)
  • Version PHP 7 and above
  • MySQL / Mariadb

Installation

The installation guide is not comprehensive and only serves as a quick guide to start a project.

Steps

Database

  • Create a MySQL user to connect the B3 database from your Webserver
  • Run the echelon.sql file on the database to create the Echelon tables

Webserver Config

Echelon 3 runs everything from the /public folder of the project structure. To help secure the instances, change the webserver config to point at the /public folder in the echelon directory by doing the following:

Nginx

// Change your root to the new /public 
server_name echelon.example.com;
root /webserver/echelon/public;

Apache

DocumentRoot "/webserver/echelon/public"
ServerName echelon.example.org
<Directory "/webserver/echelon/public">
    RewriteEngine on
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule . index.php [L]
</Directory>

Currently, Echelon 3 only works in the /public folder and not in a subdirectory. If your project requires a subdirectory for Echelon 3 then further research is required and please inform the author of any findings.

Install

  • Go to your install path and follow the installer
  • Select the box that says to delete the install folder
  • Setup and config your Echelon to your needs

Contributing

Fancy having a play? You're more than welcome to. I've got a lot of other projects on the go and this one tends to be left on the table so I'm always happy to see when others have some input or want to get down and dirty with the code. Feel free to Change, Remove, Fix or complain about anything in the code base :D

npm install
npm install -g gulp ( optional ) 

// For a normal watching build process
gulp
or
./node_modules/gulp/bin/gulp.js
// To build
gulp build
or
./node_modules/gulp/bin/gulp.js build

Contributors

MichaelHillcox // WickedShell, Specialkbyte, nathanthorpe, markweirath

Licence

GNU General Public License v3.0