Installing and configuring the Hansoft web service

When you install the Hansoft web service, the Hansoft web service API and the nginx web server are installed. The web service does not need to be installed on the same computer as the Hansoft server.

Note: The nginx web server has its own configuration file. We recommend not making changes to the file because it is overwritten every time the web service starts and your changes will be lost.

Windows

1. Make sure that all requirements are met and that you add an SDK user that syncs all projects.

2. Download the Hansoft web service.

3. Extract the contents of the downloaded .zip file to a directory.

We recommend installing the web service in C:\HPMWeb. You cannot install the web service:

Directly in the C:\Program Files or C:\Program File (x86) directories.
In a directory that contains spaces in the path.

4. In the directory you extracted the web service files to, make a copy of the HPMWebConfig.json.example file and delete .example from it. The resulting filename must be HPMWebConfig.json.

5. Edit the following values in the HPMWebConfig.json configuration file. See Editing the Hansoft web service configuration file for more information.

HansoftHost
HansoftPort
HansoftDatabase
HansoftUser
HansoftPassword
Domain
WebSSLPort

If WebSSLPort is set to 443, your URL will be https://<domain>/, and otherwise it will be https://<Domain>:<WebSSLPort>/

6. From a command prompt, navigate to the directory where you extracted the web service files.

7. Run the following command to add and start the web service:

hpmweb --daemon-add

The web service is added as a Windows service. You can stop, restart, and perform other actions on the service from the Services window. See the Windows help for information.

Tip: Use the following command for help on each command: hpmweb --help -v.

8. Configure the certificate for the web service to use and then restart the web service. See Configuring certificates for the Hansoft web service.

9. In the Hansoft client, configure the base URL for the web service. This allows users to use URLs to access Hansoft items. See Configuring the web service base URL in the Hansoft client help.

Linux

1.Make sure that all requirements are met and that you add an SDK user that syncs all projects.

2. Download the Hansoft web service.

3. Extract the contents of the downloaded .zip file to /opt/hpmweb.

It is important to install in /opt/hpmweb because a new user runs the web service and requires access to all files used by the web service.