Skip to content

Home

Jump to bottom
Shad86 edited this page Nov 25, 2020 · 47 revisions

FAQ

The official documentation how to install the Ranksystem you will find here (for Linux, for Windows)

A documentation for the single parameter/functions you will find inside the webinterface of the Ranksystem.

This Wiki is for answering the most frequently asked questions (FAQ).

Index

Automatically update function - What does this mean?

The Ranksytem updates itself fully automatic.

  1. It checks for new versions and download this to the update folder inside the Ranksystem.
  2. Before anything will done, it create a backup of the database. Be sure you have a backup of your webserver files.
  3. After this it overwrites all files on the webserver with the new version.
  4. Then it stops and wait for a restart (via cron/task or manually).
  5. With the restart it take the new binaries and do on first step the database (SQL) update.

If the defined user (Webinterface - TeamSpeak - Bot-Admin) are due this process online on the TeamSpeak server, they get informed via text message.

To check, all was updated well, you should check the ranksystem.log file.

Due the update process there will be also created a backup of the database. If something goes wrong, it is possible to restore this (contact the support).

Automatically update function - Why is there no option to disable it?

We see much user of the Ranksystem are using an old version. A few of them are still on the early beta version. This versions are outdated for a long time. In most cases it is only for lazy reasons.

With the automatically update we can be sure all of our "customer" are on the same version. This reduces the support effort much.

Also it is possible to fix much faster bugs, which increases also the security.

Multiple PHP versions - How to set the PHP version?

There is a file other/phpcommand.php. Inside this you can define the place where your PHP is installed.

Examples how to set the PHP are inside the files (for Linux and for Windows).

This file will not be touched due an update, so you have to define it once a time.

Verify process - How is it working?

On the statistics site, you will be verified with the TeamSpeak Server to see the full of your own statistics (stats/my_stats.php). For privacy reasons not all of them are directly public.

How is it working?

It uses your client IP address from the website and try to match this IP address with a user on the TeamSpeak 3 server. With that process the most (perhaps ~98%) of all user, which are on the TS3 server online, could be matched.

For all other cases, it checks also:

  • Multiple Clients: If the TS3 server has multiple user with the same IP address online, you will need to register which of them you are. You will get a list of all matched user (with that IP address) and have to choose yourself to receive a token. With that you are able to verify yourself to the Ranksystem.
  • Not matched/found: If the IP address couldn't be found on the TS3 server, you will need to register yourself. For this you will need to got the (previously defined) verification channel. You will be able to choose out of a list of the user, which are inside the verification channel. Then you will receive a token, with that you can verify yourself to the Ranksystem.

Embed the Statistic page with an IFrame

By default it should be possible to use the Ranksystem over an IFrame without doing anything. Some browser forces special options in the header to be set, it is working well.
The following header options can also be set about your web server. In this case you might want the Ranksystem does nothing. Then you need to choose the options to disable it.
Here we want to explain how to configure the Ranksystem working secure over an IFrame and also be compatible with the most common browser with the latest version. Ranksystem version 1.3.13 or above is required.

The parameter can be found in the webinterface on the 'Other' page.

domain-a.com is the website, where the Ranksystem is reachable.
domain-b.com is the website, where you want to embed the IFrame.

  • Set the "Access-Control-Allow-Origin" to "allow custom URL". Enter in the field below the address of your domain. In the example above "https://domain-b.com"
  • Set the "X-Frame-Options" to "allow custom URL". Enter in the field below the address of your domain. In the example above "https://domain-b.com"

Bot is not starting - Windows

Have a look on this extra site

Ranksystem deletes user (shown in log entry)?

Example:
2017-12-23 23:10:29.593098 NOTICE 2 clients were deleted out of the Ranksystem database, because they were no longer existing in the TeamSpeak database.

The Ranksystem do not touch (delete) any user on your TS3 server!

The Ranksystem only synchronize the TS3 database with the Ranksystem database. That means user, which were deleted on the TS3 server, will also be deleted out of the Ranksystem database.

The shown interval (Webinterface -> Other -> clean period) means only the interval how often the Ranksystem check "there are something to delete". This is not the interval after how much time an user gets deleted from the TS3 server.

If user were deleted from your TeamSpeak server, it was manually or by the TeamSpeak server itself. To change the time after which user should be deleted out of the TS3 server you have to edit the ts3server.ini (should be found in the root directory of your TS3 server installation). There you will find the option: dbclientkeepdays=30

If I remember it right the default value are 30 days and TeamSpeak also ignore all values below 30.

Reset Password Ranksystem Webinterface

At default there is an official function to reset the password about the Ranksystem Webinterface. If this isn't working, you can reset it about the following way:

  1. Connect in any way to your database (e.g. command-line mysql -uroot -p or phpMyAdmin, ...)
  2. Update your webinterface password -> here it is encrypted and stands for 6HSGwOrHd Replace the database name ts3_ranksystem with yours.
    UPDATE ts3_ranksystem.cfg_params SET VALUE='$2y$10$SB5/kuSkjsRPHIby5dZbiOpnIbDrUstNXRV6lylZ8HzT42W67ZBoW' WHERE param='webinterface_pass';
  3. Login and change the webinterface password directly with the change password function.

Ranksystem Bot does not answer on commands

The Ranksystem Bot doesn't answer on commands or is not able to write messages (e.g. on rank up)? This might be a problem the Bot is using a unique Client-ID, which is being used by another user too. To solve this, you should create a new unique Client-ID, which will be used for the Ranksystem only. This is also recommended for security reasons.

Steps to do:

  1. Create a new unique Client ID -> TS3 Client -> Tools -> Identity (CTRL + I)
  2. Join with the new unique Client ID:
    • TS3 Client Connection (CTRL + S) dialog with -> "more". Then there appears a field with "Identity".
    • Choose the new one and connect with.
  3. Give the new unique Client ID the needed permissions on the TS3 server
  4. Create the query login -> Tools -> ServerQuery Login.
  5. Enter the new query credentials inside the Ranksystem Webinterface

Use this unqiue Client ID only for the Ranksystem Bot. You musn't use this to connect to the TeamSpeak.

Changed TeamSpeak Host / Server - Mitigation old Ranksystem

  1. Export old Ranksystem (SQL) database and import this on new database server (if changed, otherwise obsolete)
  2. Copy the webfolder to the new environment (if changed, otherwise obsolete)
  3. Edit the other/dbconfig.php and correct the database connection details (if changed, otherwise obsolete)
  4. Before you start the Ranksystem Bot in your new environment, you have to edit the following things inside the Webinterface:
    1. TeamSpeak: update your TeamSpeak connection details
    2. Other: update your logpath, if it was changed
    3. Other: turn off the Client-database-ID reset
    4. Rank: change all database-IDs, which are defined:
      1. Exceptions: servergroup exception (servergroup IDs) and channel exception (channel IDs)
        Use Deselect All function before defining new groups
      2. Rank: rank up definition (servergroup IDs)
      3. Boost: boost definition (servergroup IDs)
Clone this wiki locally