Installation
Installation of SICS DOCS #
Installation on a static web-server #
Examples of compatible static web-servers:
- Apache HTTPD server (open-source)
- Nginx (open-source)
- Microsoft IIS
Example:
The web-server publishing root folder is pre-configured as /var/www/html (hereafter referred to as <publishing_root>).
(For further instructions, please refer to the official documentation from your web-server vendor.)
Step 1. Unzip #
Unzip the ZIP version of the SICS DOCS archives you want to install into a sub-folder of your own choice, under the publishing root folder of your web-server. An example is shown below:
| File | Required action |
|---|---|
sicsdocs_pc_25.3.zip |
Unzip to folder: <publishing_root>/sicsdocs/25.3/pc |
sicsdocs_life_25.3.zip |
Unzip to folder: <publishing_root>/sicsdocs/25.3/life |
sicsdocs_cede_25.3.zip |
Unzip to folder: <publishing_root>/sicsdocs/25.3/cede |
sicsdocs_sysadmin_25.3.zip |
Unzip to folder: <publishing_root>/sicsdocs/25.3/sysadmin |
Step 2. Verify in browser #
Once the folders are published, please open your browser of choice and check the URLs:
| URL | Required action |
|---|---|
http(s):<hostname>:<portnumber>://sicsdocs/25.3/pc/ |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs/25.3/life/ |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs/25.3/cede/ |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs/25.3/sysadmin/ |
Open URL in browser to verify that the SICS DOCS site is available. |
Note:
The web-server must be set up to handle “pretty URLs” (specifically; the server must append index.html to URLs ending with a slash .../).
This is usually enabled by default, on most popular web-servers.
Installation on a Java Servlet Container #
Examples of compatible Java Servlet Containers:
- Apache Tomcat 10.1, or higher (open source)
Step 1. Deploy WAR file (Tomcat-example) #
Deploy the WAR version of the SICS DOCS archive files you want to install into Tomcat’s webapps folder:
| File | Required action |
|---|---|
sicsdocs_pc_25.3.war |
Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it. |
sicsdocs_life_25.3.war |
Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it. |
sicsdocs_cede_25.3.war |
Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it. |
sicsdocs_sysadmin_25.3.war |
Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it. |
Step 2. Verify in browser. #
Once deployed, please open your browser of choice, and check the urls:
| URL | Required action |
|---|---|
http(s):<hostname>:<portnumber>://sicsdocs_pc_25.3/index.html |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs_life_25.3/index.html |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs_cede_25.3/index.html |
Open URL in browser to verify that the SICS DOCS site is available. |
http(s):<hostname>:<portnumber>://sicsdocs_sysadmin_25.3/index.html |
Open URL in browser to verify that the SICS DOCS site is available. |
Note:
The war files have a pretty-URL rewriting filter built in. So URLs ending with a slash .../ with automatically be translated to .../index.html. This is necessary for the documentation to work.
SICS Online Help-function #
SICS configuration #
| File | Description |
|---|---|
sics.global.resource.registry.properties |
This file contains configuration settings for SICS DOCS, and many other SICS functions. |
Configure SICS Online Help #
Make SICS DOCS the preferred choice when opening the “Online Help”-function in SICS Workstation or SICS Sys Admin Utility:
Edit file sics.global.resource.registry.properties to activate SICS DOCS as Online Help from SICS Workstation and SICS SysAdmin Utility.
| Product | Configuration setting (example) |
|---|---|
| SICS Sys Admin | SystemAdminHelpURL=http://<host>:<port>/sicsdocs/25.3/sysadmin/ |
| SICS P&C Workstation | SicsPcUserGuideHelpURL=http://<host>:<port>/sicsdocs/25.3/pc/ |
| SICS Life Workstation | SicsLfUserGuideHelpURL=http://<host>:<port>/sicsdocs/25.3/life/ |
If these are enabled, make sure the URL points to the published SICS DOCS site on your web-server.
Configure “What’s New”-function #
Make SICS DOCS the preferred choice when opening the “What’s new”-function in SICS Workstation or SICS Sys Admin Utility:
| Product | Configuration setting (example) |
|---|---|
| SICS Sys Admin | SystemAdminWhatsNewURL=http://<host>:<port>/sicsdocs/25.3/sysadmin/sicsdocs/releases/25.3/release_documentation/whats_new/ |
| SICS P&C Workstation | SicsPcUserGuideWhatsNewURL=http://<host>:<port>/sicsdocs/25.3/pc/sicsdocs/releases/25.3/release_documentation/whats_new/ |
| SICS Life Workstation | SicsLfUserGuideWhatsNewURL=http://<host>:<port>/sicsdocs/25.3/life/sicsdocs/releases/25.3/release_documentation/whats_new/ |
If these are enabled, make sure the URL points to the published SICS DOCS site on your web-server.