CSI Web Server Administrator

The CSI Web Server Administrator allows you to configure the web server, check the status of the web server, set up user accounts and passwords, and easily browse to sites running on the web server. It can be opened from the Windows Start Menu by selecting CsiWebAdmin

Status

The Status tab shows the status of the web server and allows you to browse to sites running on the web server.

If the web server is not running, click on the image to start the web server.

When the web server is running, the version of the web server running will be displayed. The protocol, port, and status (e.g., Protocol HTTP, port 80, status Listening) will also be displayed.

A list of sites provided by the web server will be shown. You can click on any site to browse to that site.

A lock icon (  ) next to a site indicates that there is not a user account with at least read only access to that site. Therefore, it can not be accessed. See Web Security for more information about user accounts and how they control users and their website access rights.

The keys icon (  ) next to each site can be used to create or edit the user accounts for that site. See Web Security for more information about user accounts and how they control users and their website access rights.

The plus icon (  ) next to "Root" creates a new remote folder. You can then use the keys icon next to the new remote folder to create the user accounts for that remote folder before publishing a website to the folder. See Web Publisher for information on publishing a website to the remote folder.

The trash can icon next to each website can be used to remove the website.

NOTE: Only sites published to the web server’s root directory and immediate subdirectories of the root directory will be shown. Sites cannot be published to deeper subdirectories.

Configuration

HTTP

The HTTP tab controls the root directory and HTTP server port that will be used by the CSI Web Server.

HTML Root Directory – The directory that the web server will use to store/serve web pages, scripts, password files, and source description files

HTTP Server Port – The TCP Port on which the HTTP server will listen for unencrypted connections. You may need to change this port if there is already a web server running on this machine or if your firewall does not allow service on TCP port 80.

HTTPS

NOTE: When HTTPS is enabled, the CSI Web Server uses HSTS (HTTP Strict Transport Security). This means that if someone attempts to connect with HTTP, the server will respond with a message stating that the browser should use HTTPS, at which point most browsers will automatically switch to HTTPS.

The HTTPS tab can be used to set up the CSI Web Server for encrypted service. This requires a Private Key File and Certificate File obtained from a third party Certificate Authority. See Obtaining certificate and private key and Applying keys and certificates to CSI Web Server for more information.

HTTPS Enabled – Specifies whether the web server will attempt to offer an HTTPS (encrypted) service.

Server Name – Specifies the domain name that the server will report when it redirects requests from an unsecure link to a secure one. This will only happen if the HTTPS protocol is enabled and the private key and certificate have valid content. This value should be the Fully Qualified Domain Name (FQDN) for your web server and, depending upon firewalls, proxies, and port-forwarding configurations, may be different from the host machine name.

HTTPS Server Port – Specifies the TCP port on which the HTTPS server will listen for unencrypted connections. You may need to change this port if there is already a web server running on this machine or if your network or personal firewall do not allow service on TCP port 443.

Private Key File – Specifies the name of the PEM encoded file that contains the HTTPS private key. The TLS/SSL stack used by the web server supports only AES128 or AES256 encryption for the private key file.

The private key should be placed into a directory that the username which the CSI Web Server is running under has access to.

Two clear signs that your private key file is in the correct format are:

  1. The file extension you received it in is .pem.

  2. When opening a copy of the key file in Notepad or other ASCII text editor, it has header and footer information similar to the following:

    -----BEGIN RSA PRIVATE KEY-----

    [Unreadable Content goes here]

    -----END RSA PRIVATE KEY-----

    If this information does not match your key file, it is in the wrong format.

Private Key Password – Specifies the password used to decrypt the TLS/SSL private key. It will be ignored if a private key is specified that is not encrypted.

Certificate File – Specifies the name of the PEM-encoded file that contains the x509 HTTPS certificate.

The certificate file should be placed into a directory that the username which the CSI Web Server is running under has access to.

Two clear signs that your certificate file is in the correct format are:

  1. The file extension you received it in is .crt.

  2. When opening a copy of the certificate file in Notepad or other ASCII text editor, it has header and footer information similar to the following:

    -----BEGIN CERTIFICATE-----

    [Unreadable Content goes here]

    -----END CERTIFICATE-----

    If this information does not match your certificate file, it is in the wrong format.

Log Control

The Log Control tab allows you to configure how log files are maintained by the CSI Web Server.

Log File Mode – Controls the way that the web server will write its log files. Select Disabled to disable log files, New Log on Time Intervals to specify that a new log file will be started on the time interval specified by the Baling Interval, or New Log after Max Size to specify that a new log file will be started after the current log file exceeds the size specified by the Maximum Log File Size. Log files will be stored in C:\Campbellsci\CsiWebServer\sys\logs.

Baling Interval – Specifies the maximum time interval that will be recorded in any one log file when the Log File Mode is set to New Log on Time Intervals.

Maximum Log File Size – Specifies the maximum size (in bytes) that will be recorded in any one log file when the Log File Mode is set to New Log after Max Size.

Maximum Log Files Count – Specifies the maximum number of log files that will be kept by the web server before the oldest is overwritten.

Log HTTP Headers – Controls whether the web server will write the headers of HTTP requests and HTTP responses in its log file.