Using the online help locally

By default, the Management Client’s online help is accessed through the Internet. When you use the online help locally, the online help is available even when there is no Internet connectivity.

Note: When you use a local copy of the online help, you must manually update the online help when a new version is available.

Use the online help locally with an installed Management Client

When you have installed the Management Client on your own computer, you can configure the Management Client to use a copy of the online help from your own computer or from a server in the local network.

Steps

  1. Download the online help .zip file for your release from http://⁠help.stonesoft.com/onlinehelp/StoneGate/SMC/.
  2. Extract the .zip file to a suitable location in your local network.
    You can also extract the Help file to a share or your local intranet server.
  3. On the computer where you use the Management Client, browse to the <user home>/.stonegate/data folder.
    Example: In Windows, browse to C:\Users\<user_name>\.stonegate.
    Note: If the Management Client is open, close it before editing the SGClientConfiguration.txt file.
  4. Edit the SGClientConfiguration.txt file.
  5. Add a parameter HELP_SERVER_URL= and enter the path to the main folder under which the online help files are stored as the value for the parameter.
    • If you extracted the online help on the same computer where you use the Management Client, enter file:/// and the path.

      Example: If you extracted the online help on your own computer to C:\help\ngfw_680_help_a_en-us, enter HELP_SERVER_URL=file:///C:/help/ngfw_680_help_a_en-us.

      Note: Use only forward slashes (/) in the URL even if the operating system uses backslashes (\) in file paths. If the path contains spaces, replace them with %20 in the URL.
    • If you extracted the online help on a server in the local network, enter http:// and the path.

      Example: If you extracted the online help to a folder called ngfw_680_help_a_en-us on an intranet server, enter HELP_SERVER_URL=http://<intranet.server>/ngfw_680_help_a_en-us.

  6. Save the changes to the SGClientConfiguration.txt file.
  7. Start the Management Client.

Result

The Management Client automatically uses the online help from the specified location.

Use the online help locally with SMC Web Access

When you use SMC Web Access, you can configure the Management Server or Web Portal Server to use a local copy of the Online Help for Management Client sessions in a web browser.

Steps

  1. Download the online help .zip file for your release from http://⁠help.stonesoft.com/onlinehelp/StoneGate/SMC/.
  2. On the Management Server or Web Portal Server host where SMC Web Access is enabled, create the following folder: <smc_installation_folder>/webserver/webswing/main/Help.
  3. Copy the online Help .zip file to the <smc_installation_folder>/webserver/webswing/main/Help folder and extract the content.
  4. (Linux only) Recursively change the owner of the <smc_installation_folder>/webserver/webswing/main/Help directory to the sgadmin user.
    Example:
    # chown -R sgadmin:sgadmin /usr/local/forcepoint/smc/webserver/webswing/main/Help/
  5. On the Management Server or Web Portal Server host where SMC Web Access is enabled, browse to the <smc_installation_folder>/data folder.
    Note: If you installed the Management Server in the C:\Program Files\Forcepoint\SMC folder in Windows, the SGClientConfiguration.txt file is located in the C:\ProgramData folder.
  6. Edit the SGClientConfiguration.txt file.
  7. Add a parameter HELP_SERVER_URL=https://<SMC_Web_Access_IP>:<Web_Access_port>/Help/.
    Example: If the IP address of the Management Server is 192.168.100.55 and the listening port for SMC Web Access is 8085, enter HELP_SERVER_URL=https://192.168.100.55:8085/Help/.
  8. Save the changes to the SGClientConfiguration.txt file.
  9. Exit your Management Client session and open new session.

Result

Management Client sessions in a web browser now automatically use the Online Help from the specified URL.