• Examples (iOS)
• Examples (Android)
• Examples (C++)
Server API Documentation


» Extension Manager module

The AdminTool's Extension Manager module allows administrators to upload the server-side Zone and Room Extensions without using additional tools (for example FTP transfer managers). The module also controls the Extensions reloading, to immediately activate the new version of the Zone Extensions without restarting the server.

Server Configurator module

As this module allows to upload any kind of file to the server, in order to improve the security a physical lock has been placed on the server preventing the usage until it is removed. This means that even if you forget to change the default access credentials for the AdminTool and a malicious won't be able to take advantage of it.
To enable the module you have to remove the ExtensionManagerLock.txt file contained in the server's config folder by accessing the server directly (via FTP or using a terminal/console window).

Please make absolutely sure to first setup a secure password before unlocking the ExtensionManager.

As the module leverages the uploading feature introduced in SmartFoxServer starting from version 2.9, in addition to the above, the module requires the internal web server to be running and the HTTP protocol to be active in the Web server tab of the Server Configurator module.

» Usage

The left side of the module shows the list of folders and files currently existing in the server's extensions folder, including the __lib__ folder where library classes can be deployed and serve multiple Extensions.
In order to upload a new Extension, create its folder by entering a name in the textbox below the list and hit the Create folder button. The new folder will be displayed and selected in the list: you can now click the Upload files button. Select the file/s to be uploaded in the operating system window popping up; when confirming, a summary table will list the files, requiring one more confirmation.

The files being uploaded are listed in the queue on the right side of the module, together with their completion percentage and explanatory details in case an error occurs. Upon completion of each file, the left list is refreshed showing the new item. In case of Zone Extensions, one last step to make the server start using the newly added Extension is to assign it to a Zone using the Zone Configurator module.
Please note that the items in the uploading queue are handled sequentially: the Cancel uploading button allows stopping the current upload and the following.

In order to update an existing Extension, simply select the target folder in the left list and follow the same procedure to upload the files: the existing files on the server will be overwritten without further notice.
Also, in case of an update, it is usually required to make the server run the new version of the Extension immediately. This is possible for Zone Extensions only by hitting the Reload Extension button after selecting the top folder or one of its children.

Use the Remove selected button to delete one or more files (CTRL-click / CMD-click to select multiple) from the server.


« back to AdminTool