SFS2X Docs / GettingStarted / admintool
» The Administration Tool
The Administration Tool, also known as AdminTool, is a powerful application for SmartFoxServer 2X remote monitoring and management. Its main features are:
- advanced visual configuration of all the server settings, including Zones and Rooms;
- powerful runtime monitoring tools which allow checking Zones, Rooms and users on the live server, with advanced Rooms and users filtering capabilities, statistics and more;
- complete runtime data showing the live server status at a glance, letting administrators to keep the server performance under strict control;
- advanced console for in-depth traffic analysis, including visits, unique and new visitors, % new visits, demographics data aggregation, client technology statistics and much more;
- kick and ban users, and manage the banned usernames / IP addresses lists;
- multiple administrators can access the tool at the same time and work together discussing issues live thanks to the included chat panel;
- advanced server profiles management which allows connection parameters to multiple servers to be saved, grouped, exported to file and imported into another AdminTool instance;
- modular architecture allowing fast deployment of additional administration modules (in the future also custom modules).
The following paragraphs describe how to access the Administration Tool, how to connect to SmartFoxServer 2X and how to handle multiple server profiles, and give an overview on the AdminTool's user interface. The available administration modules are described in dedicated pages linked below.
» Accessing the AdminTool
After completing the SmartFoxServer 2X installation successfully, in order to rapidly access the AdminTool point your browser to http://localhost:8080/admin/.
When the main connection panel is displayed (more on this in the next paragraph), you can connect to your local SFS2X instance immediately by entering the following details:
- Host: localhost
- Port: 9933
- Username: sfsadmin
- Password: sfsadmin
The predefined administrator (sfsadmin) should be removed as soon as possible, creating a new administrator user in the Remote Admin tab of the Server Configurator module (see below). This is very important in particular when the server is put online and can be accessed publicly.
» The connection panel
The connection panel is the first screen you will be presented after launching the AdminTool. It consists of a Connection tab and a Bookmarks tab.
The Connection tab allows the administrator to enter the connection details directly and access the server administration by pressing the Connect button:
- Host: can be a domain name or an IP address;
- Port: the TCP port dedicated to server administration;
- Username and Password: the administrator's access credentials.
The provided connection details are validated against the settings entered in the Remote Admin tab of the Server Configurator module to allow or deny the access to the user.
Communication between the AdminTool's client and the SFS2X instance can be encrypted by activating the Encrypt switch in the Connection tab. This requires SFS2X to be previously configured as described in the Protocol Cryptography document (in this case you don't have to configure a Zone's encryption settings, but enable AdminTool's encryption in the Remote Admin tab mentioned above).
If the Remember me switch is enabled, the connection details (except the password) are saved and the form is filled in automatically the next time the AdminTool is opened.
The Bookmarks tab allows the creation of profiles in which the server connection settings can be saved (all except the password, for security reasons). In this way administrators can access several SFS2X instances within the same AdminTool (no matter where it is located) and without worrying about remembering IP/ports/usernames each time.
Bookmarks can be arranged into custom groups to better organize the profiles.
When you double click an existing profile (or click the Use profile button after selecting a profile), it will bring you back to the Connection tab and populate all the fields: simply enter the password and click the Connect button.
Click on the buttons to add, edit or remove a group (left column) or a profile inside the selected group (right column). The AdminToll makes use of the Flash Player's shared objects to save the bookmarks. By means of the and buttons it is also possible, respectively, to export the groups and profiles to an xml file, and import them back. This allows moving the profiles to other client machines without the need to re-enter them each time.
As an example, clicking on this link you can download a profiles file (unzip it to get the xml) to be imported in your AdminTool which contains the localhost connection settings mentioned in the Accessing the AdminTool paragraph above.
After the successful connection to a SmartFoxServer 2X instance, the following administration modules are available. Click on the module's name to access its specific documentation. Modules can be ideally divided into two categories:
|Dashboard||Live server information (CPU, memory, traffic, threads, etc)|
|Zone Monitor||Runtime monitoring of SFS2X Zones, Rooms and users|
|Analytics||Reporting console per business data analysis|
|Ban Manager||Advanced form for users banishment and ban lists management|
|Log Viewer||SFS2X boot and runtime logs view and backup|
|BlueBox Monitor||Runtime monitoring of HTTP-tunnelled connections|
|Server Configurator||Configuration of SFS2X global settings|
|Zone Configurator||Creation and configuration of SFS2X Zones and static Rooms|
|Extension Manager||Server Extensions files uploading|
|License Manager||SFS2X license setup and test|
Modules can be loaded by clicking on their icons in the AdminTool's main header.
» The AdminTool's main interface
The following image shows the main user interface of the AdminTool.
The central zone of the interface is where the administration modules are loaded (faded in the image). The other relevant interface elements are:
- The left side of the header contains the icons of the modules described previously, displayed as tabs. Click one of them to load the corresponding module. A tooltip also shows the name and a brief description.
The "save last" switch is also displayed at the right of the last tab. When enabled (green), the AdminTool "remembers" the last opened module and will load it automatically the next time it is accessed. If disabled, the AdminTool will load the Dashboard module by default.
- The top right corner shows the version of the SFS2X instance to which the AdminTool is connected.
- The Restart (orange) and Halt (red) buttons respectively stop the server and stop-restart it; of course this causes an immediate disconnection of the administrator [please read the notes in the box below].
- The Chat button shows the administrators' activity and chat panel. Using this panel, administrator connected to the same SFS2X instance can discuss in the internal public chat and check each other's activity: the table at the top of the panel shows each administrator's name, his connection time and the administration module he his currently using. If a chat message is received while the panel is collapsed, the button's icon blinks. Click the button again to close the chat panel.
- The Help button opens the current module's documentation in a new browser window.
- The Logout button closes the current connection to SFS2X and switches the view back to the connection panel.
- The title bar shows the server's host and port number followed by the current module's name; if a custom name is assigned to the SFS2X instance (see the Server Configurator module), it is displayed in the title bar too.
- The AdminTool's footer displays system messages, which are logged automatically after some seconds; red messages indicate specific errors or warnings.
- The Clear button has a dual usage: when the log is displayed (see J), it deletes the whole log; when the log is hidden, it removes the currently displayed system message (see H);
- the Log button shows/hides the area where system messages are logged during the current AdminTool's usage session.
IMPORTANT NOTES ON HALT AND RESTART FUNCTIONS
1) Supported operating systems: Windows, Linux, OSX.
2) When SFS2X is restarted using the AdminTool, a new process is created, which is not detected by the command line tool. This means that you can either control the server via command line or via AdminTool, but you can't mix the two.
3) During the restart process, some exceptions may be logged: this is normal and those exceptions are harmless, in fact you will be able to access your SFS2X instance using the AdminTool in a few seconds.
» Server updates
Starting from the AdminTool version shipped with SmartFoxServer 2X v2.1.0, a basic server version check system is provided. The AdminTool automatically checks if a new version of SFS2X is available on the website as a full installer or a patch. In case it is found, the version number in the header (see B above) is turned into a button: clicking it opens a panel showing the update details and a button to go to the download page (no automatic installation is provided).