The basic php script used for private servers to submit information about their server to the Ashita backend services. (Used to display private server information within the Ashita launcher.)

2.2 KiB

Raw Permalink Blame History

CollectionApi

The basic php script used for private servers to submit information about their server to the Ashita backend services. (Used to display private server information within the Ashita launcher.)

Setup

This script is designed to be super light-weight and minimal on requirements and similar.

In order to use this script, you need to have:

PHP (At least 5.1.x is needed, 7.x is recommended.)
PHP PDO Enabled (Automatically enabled on newer versions of PHP)

To install, simply download, or clone, this respository into a new directory on your website/webserver.

Next, open and edit the config.php file to be adjusted for your private server information.

$config['db'] - This setting array controls access to the database server to gain access to the 'accounts_sessions' table of your server.
$config['cache'] - This setting array controls the various options for the caching. (These are used to help reduce the load on your server and limit how often the script queries your database for new information.)
$config['server'] - this setting array controls the server specific information for your server. (The 'lifetime' option handles how often Ashita's service will attempt to re-query for your servers information limiting how often it accesses this script.)

Testing

Lastly, to test you simply just need to browse to your website folder where you have installed this script, such as: http://www.example.com/ashita/ashita.php

If properly installed the site should return a json blob of data about your servers current information.

Recommended MySQL Setup

This script ONLY does a single SELECT call to the database. Because of this small footprint, it is highly recommended to create a custom account specifically for this script and ONLY give it access to the SELECT command on the DarkStar database of your server. This helps limit any potential exploits with this script or any future changes that will come to it.

Getting Listed Within Ashita Launcher

In order to get your server listed in the Ashita launcher, you will need to contact atom0s directly on Discord. You can find me within the Ashita general chat channel here: https://discord.gg/CfZu6Ya