AsgardEternal/SquadJS
1
0
Fork 0
mirror of https://github.com/AsgardEternal/SquadJS.git synced 2024-09-28 17:34:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix mysql-log schema link

Browse Source
This commit is contained in:
Thomas Smyth 2020-09-02 09:30:37 +01:00
parent 8feb8d630b
commit c22f69cd7d
3 changed files with 2 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -461,7 +461,7 @@ The `mysql-log` plugin will log various server statistics and events to a MySQL
Installation:
* Obtain/Install MySQL. MySQL v8.x.x has been tested with this plugin and is recommended.
* Enable legacy authentication in your database using [this guide](https://stackoverflow.com/questions/50093144/mysql-8-0-client-does-not-support-authentication-protocol-requested-by-server).
* Execute the [schema](mysql-schema.sql) to setup the database.
* Execute the [schema](https://github.com/Thomas-Smyth/SquadJS/blob/master/plugins/mysql-log/mysql-schema.sql) to setup the database.
* Add a server to the database with `INSERT INTO Server (name) VALUES ("Your Server Name");`.
* Find the ID of the server you just inserted with `SELECT * FROM Server;`.
* Replace the server ID in your config with the ID from the inserted record in the database.

34
plugins/mysql-log/README.md
View File

@ -1,34 +0,0 @@
<div align="center">
<img src="../../core/assets/squadjs-logo.png" alt="Logo" width="500"/>
#### SquadJS - MySQL Log
</div>
## About
The MySQL log plugin logs event information into a MySQL database to allow it to be queried for analysis, monitoring, or stat tracking. Works well with Grafana.
## Requirements
* MySQL database (This plugin has been tried with version 8.x.x, so it is suggested you use the same).
* You may need to enable a different authentication method for it to work. Follow [this guide](https://stackoverflow.com/questions/50093144/mysql-8-0-client-does-not-support-authentication-protocol-requested-by-server) to learn how to do that.
* Execute the [`mysql-schema.sql`](https://github.com/Thomas-Smyth/SquadJS/blob/master/plugins/mysql-log/mysql-schema.sql) in the database to setup the tables, etc.
* Add your server to the database... `INSERT INTO Server (name) VALUES ("[EU] The Coalition");` Please make sure the inserted ID is the same as that of the server in the `index.js` file.
* If you encounter any issues with this plugin, enable `debug: true` in the `mysql.createPool` constructor. This will cause errors to be logged to the console.
## Installation
```js
// Place the following two lines at the top of your index.js file.
import mysql from 'mysql';
import { mysqlLog } from 'plugins';
// Place the following lines in your index.js file. Replace the credentials with the credentials of your MySQL database.
const mysqlPool = mysql.createPool({
connectionLimit: 10,
host: 'host',
port: 3306,
user: 'squadjs',
password: 'password',
database: 'squadjs'
});
mysqlLog(server, mysqlPool);
```

2
plugins/mysql-log/index.js
View File

@ -16,7 +16,7 @@ export default {
'Installation:\n' +
' * Obtain/Install MySQL. MySQL v8.x.x has been tested with this plugin and is recommended.\n' +
' * Enable legacy authentication in your database using [this guide](https://stackoverflow.com/questions/50093144/mysql-8-0-client-does-not-support-authentication-protocol-requested-by-server).\n' +
' * Execute the [schema](mysql-schema.sql) to setup the database.\n' +
' * Execute the [schema](https://github.com/Thomas-Smyth/SquadJS/blob/master/plugins/mysql-log/mysql-schema.sql) to setup the database.\n' +
' * Add a server to the database with `INSERT INTO Server (name) VALUES ("Your Server Name");`.\n' +
' * Find the ID of the server you just inserted with `SELECT * FROM Server;`.\n' +
' * Replace the server ID in your config with the ID from the inserted record in the database.\n' +