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


» Installing under macOS

All client and server versions of macOS are supported starting from Mountain Lion (10.8).
You can start the installation by mounting the downloaded .dmg file and double clicking the installer program.

» Running SmartFoxServer 2X

We provide options for running SFS2X in two different modes.

During the installation process you will be asked if you want to install SFS2X as Service.

» Running SmartFoxServer 2X as an application

Simply double click the SFS2X icon under the {sfs2x-install-dir}/SFS2X/ folder to launch the server.

In alternative you can execute the sfs2x script to run the server in standalone mode and see the logs directly in the terminal (useful for development). Open the terminal, go to the {sfs-install-dir}/SFS2X/ folder and type:


Using the script to run SFS2X in standalone mode is mandatory if you change the Java Virtual Machine settings using the AdminTool (see the Server Configurator documentation), because the SFS2X launcher uses its own embedded settings and ignores the others.

» Running SmartFoxServer 2X as a Service

The SFS2X service (or "daemon" for Unix environments) is controlled via the sfs2x-service script located under {sfs-install-dir}/SFS2X/

The script provides the following switches:

In order to start the process, open a terminal window and type:

./sfs2x-service start

Similarly you can stop the process using the stop switch.

Please notice that if you are running the server as service/daemon you will need to use the sudo command:

sudo ./sfs2x-service start

» Uninstalling SmartFoxServer 2X

A convenient Uninstall program is provided in the installation folder, which completely removes the software from your system. The removal implies also that your custom settings and data will be lost. Proceed carefully with uninstalling SFS2X if you want to keep your settings.


« previous page