From ec71d7ecd63eaf5e9a83cd6f573b17a85873aaeb Mon Sep 17 00:00:00 2001 From: Ruan Date: Tue, 6 Mar 2018 21:00:38 +0200 Subject: [PATCH] Created Installation (markdown) --- Installation.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Installation.md diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..599de77 --- /dev/null +++ b/Installation.md @@ -0,0 +1,22 @@ +## Requirements + +Requires an existing website and PHP 5+ (PDO extension must be enabled). + +The web interface cannot be directly hosted on Enjin, see FAQ. + +In order for the web interface to work, your MySQL database must be externally accessible for both the plugin and the website. MySQL servers are not configured by default to allow remote connections. + +## Installation + +Installation steps: +1. Download the latest version of the web interface from [here](https://github.com/ruany/litebans-php/archive/master.zip). +2. Extract the files onto your web server (web server root or public_html). The directory "litebans-php-master" will contain all extracted files, you can rename it or move the files inside of it as needed. +Browse to the location on your website where the files were extracted to. If your website is "example.com" and the web interface directory is named "bans", visit "example.com/bans/index.php". +3. Follow the instructions that are given to you by the web interface. You will need to edit inc/settings.php. The web interface needs to be configured to connect to the same MySQL database which the plugin is connecting to, so your MySQL server needs to be capable of accepting external connections from both the plugin and the web server. + +## Customization + +The web interface can be customized by changing the Bootstrap theme (inc/css/bootstrap.min.css). +You can find Bootstrap themes at https://bootswatch.com/. + +You can also try the Material Design Theme by @TheGuildsPlugin.