Setup Web Platform

Register organisation
Start by going to https://web.staffplusplus.org/ and clicking on "I want to register my organisation". This will take you to the page where you can create an account.
Fill in your credentials an choose an application name which fits your organisation best.
Once you register you will need to verify your email. After verification you will be taken to your application's admin panel.
General settings
Once you are able to access your dashboard go to the General Settings
This takes you to the configuration page where you can edit your organisation details like name, logo and connection url.
Fill in the connection url to your server. Or something else. It doesn't have to be a real url.
Upload your logo. Preferably an image of at least 80x80 px
Set your organisation's visibility. By default your organisation can't be found by other users of the platform.
Save your settings
Once that is done, your organisation dashboard should already be visible. To verify this. Click on "Exit Admin interface" in the menu on the left. This takes you to the dashboard of your application.
You can't really do anything yet, but you should be able to see it. 
Head back over to the admin interface.
Server groups
Your organisation needs at least one server group. A server group is a collection of servers linked by the same Staff++ database. You set it up and configure every or some servers that are in your network. If you only have 1 server you only need to configure one.
On the server groups overview click "create".
Fill in your Name. Just choose something that describes these servers best. Like mini-games.
Check public access if you want to make this server group visible to everyone". When public access is checked you will notice a "Public permissions" section is added, here you can finetune what information should actually be accessible for none registered users.
Check all features you want to have enabled. warnings bans mutes
At least one feature must be enabled!
Database Connection
You need a Mysql Database.
Make sure your Mysql database is accessible from the Staff++ web platform.
All servers using Staff++ that you want to include in one server group need to be connected to the same Mysql database. That Mysql database connection must also be configured on the web platform, inside the server group configuration.
Save the server group. You should now see the server group on your overview.
Click on edit and make sure the database connection is not giving you any errors.
If the connection does fail, an error message will be shown like this:
This can only happen if either the credentials are incorrect or the database can't be accessed. If you don't have any error, continue with the following section.
Linking Servers
When editing your server group you will now see there is a new section called "Linked Servers". Here we will configure every server for which we want data to be available on the platform. In my example I only have one server.
Click on the "ADD SERVER" button. This will open up a dialog.
The first part is the most important one. 
The Server Name should be exactly the same as the property server-name configured inside your config.yml file.
Click on OK and your server should now be visible in the list of linked servers.
Add all servers you want to see on the dashboard. After the servers are setup exit the admin interface. If you configured your server group to be fully publicly available, you are done here. You should be able to see the dashboard and all information.
User registration
 Players on your server can register to your server group by accessing your server and executing the register command. More information can be found on this page.
When executing that command, a registration url is returned. This url can be used to link your staff++ account to the server group of the server from which you executed the command.
You can finetune permission and roles for user through the "roles & permission" section of the admin panel. Choosing what information is available to which users on the platform.

Video Tutorial
I only had time to make the 2 following videos and it's unedited.
Basic setup
User Registration
​

Web Platform - Previous

Next - Web Platform

Architecture

Last modified 7mo ago

Copy link

Contents