Campbell Scientific CSI Software Instruction Manual PDF

IN ST

R U

C T

IO N

M A

N U

A L

CSI Web Server for Linux Installation Guide

Revision: 3/18

C o p y r i g h t 2 0 0 6 - 2 0 1 8 C a m p b e l l S c i e n t i f i c , I n c .

License for Use This software is protected by United States copyright law and international copyright treaty provisions. The installation and use of this software constitutes an agreement to abide by the provisions of this license agreement.

Campbell Scientific grants you a non-exclusive license to use this software in accordance with the following:

(1) The purchase of this software allows you to install and use a single instance of the software on one physical computer or one virtual machine only.

(2) This software cannot be loaded on a network server for the purposes of distribution or for access to the software by multiple operators. If the software can be used from any computer other than the computer on which it is installed, you must license a copy of the software for each additional computer from which the software may be accessed.

(3) If this copy of the software is an upgrade from a previous version, you must possess a valid license for the earlier version of software. You may continue to use the earlier copy of software only if the upgrade copy and earlier version are installed and used on the same computer. The earlier version of software may not be installed and used on a separate computer or transferred to another party.

(4) This software package is licensed as a single product. Its component parts may not be separated for use on more than one computer.

(5) You may make one (1) backup copy of this software onto media similar to the original distribution, to protect your investment in the software in case of damage or loss. This backup copy can be used only to replace an unusable copy of the original installation media.

This software may not be sold, included or redistributed in any other software, or altered in any way without prior written permission from Campbell Scientific. All copyright notices and labeling must be left intact.

Limited Warranty The following warranties are in effect for ninety (90) days from the date of shipment of the original purchase. These warranties are not extended by the installation of upgrades or patches offered free of charge.

Campbell Scientific warrants that the installation media on which the software is recorded and the documentation provided with it are free from physical defects in materials and workmanship under normal use. The warranty does not cover any installation media that has been damaged, lost, or abused. You are urged to make a backup copy (as set forth above) and record the CD key to protect your investment. Damaged or lost media is the sole responsibility of the licensee and will not be replaced by Campbell Scientific.

Campbell Scientific warrants that the software itself will perform substantially in accordance with the specifications set forth in the instruction manual when properly installed and used in a manner consistent with the published recommendations, including recommended system requirements. Campbell Scientific does not warrant that the software will meet licensees requirements for use, or that the software or documentation are error free, or that the operation of the software will be uninterrupted.

Campbell Scientific will either replace or correct any software that does not perform substantially according to the specifications set forth in the instruction manual with a corrected copy of the software or corrective code. In the case of significant error in the installation media or documentation, Campbell Scientific will correct errors without charge by providing new media, addenda, or substitute pages. If Campbell Scientific is unable to replace defective media or documentation, or if it is unable to provide corrected software or corrected documentation within a reasonable time, it will either replace the software with a functionally similar program or refund the purchase price paid for the software.

All warranties of merchantability and fitness for a particular purpose are disclaimed and excluded. Campbell Scientific shall not in any case be liable for special, incidental, consequential, indirect, or other similar damages even if Campbell Scientific has been advised of the possibility of such damages. Campbell Scientific is not responsible for any costs incurred as a result of lost profits or revenue, loss of use of the software, loss of data, cost of re-creating lost data, the cost of any substitute program, telecommunication access costs, claims by any party other than licensee, or for other similar costs.

This warranty does not cover any software that has been altered or changed in any way by anyone other than Campbell Scientific. Campbell Scientific is not responsible for problems caused by computer hardware, computer operating systems, or the use of Campbell Scientifics software with non-Campbell Scientific software.

Licensees sole and exclusive remedy is set forth in this limited warranty. Campbell Scientifics aggregate liability arising from or relating to this agreement or the software or documentation (regardless of the form of action; e.g., contract, tort, computer malpractice, fraud and/or otherwise) is limited to the purchase price paid by the licensee.

i

Table of Contents PDF viewers: These page numbers refer to the printed version of this document. Use the PDF reader bookmarks tab for links to specific sections.

1. Introduction ................................................................ 1

2. Requirements ............................................................. 1

3. Installing CSI Web Server for Linux .......................... 1

3.1 DEB Installation (Debian and Ubuntu) ................................................ 1 3.1.1 Installing the Web Server .............................................................. 1

3.1.1.1 Locate the DEB File ........................................................... 1 3.1.1.2 Log In as a Root User ......................................................... 1 3.1.1.3 Use dpkg to Install the Software ........................................ 2 3.1.1.4 Alternatives to the dpkg Command Line ............................ 2

3.1.2 Installing the Admin Utility .......................................................... 2 3.2 RPM Installation (Red Hat) ................................................................. 3

3.2.1 Installing the Web Server .............................................................. 3 3.2.1.1 Locate the RPM for Your Distribution ............................... 3 3.2.1.2 Log In as a Root User ......................................................... 3 3.2.1.3 Use RPM to Install the Software ........................................ 3 3.2.1.4 Alternatives to the RPM Command Line ........................... 3

3.2.2 Installing the Admin Utility .......................................................... 3

4. What the RPM/DEB Installs ....................................... 4

5. Usage Notes ............................................................... 4

5.1 Starting and Stopping the Web Server ................................................. 4 5.2 Launching the CSIWebAdmin Package ............................................... 5 5.3 Changing the Web Server Configuration File ...................................... 5

5.3.1 Location of the Web Server Configuration File ............................ 5 5.3.2 Organization of the Configuration File ......................................... 5

5.3.2.1 http-settings Element .......................................................... 5 5.3.2.2 log-settings Element ........................................................... 6

5.3.3 Editing the Configuration File ...................................................... 6 5.3.4 Configuration File Auto-Update ................................................... 7

5.4 Security ................................................................................................ 7 5.5 Command Line Options ....................................................................... 8

1

CSI Web Server for Linux Installation Guide 1. Introduction

CSI Web Server for Linux is a port (that is, feature-equivalent implementation) of the Campbell Scientific CSI Web Server product and CSI Web Server Administrator to the Linux Operating System along with one copy of Web Publisher for Windows. This package does not provide a Linux based Web Publisher. The Web Publisher is installed on a Windows machine and used to publish RTMC projects to the Linux based CSI Web Server.

This document focuses mainly on the installation and configuration of the CSI Web Server for Linux. For additional information on using the CSI Web Server as well as the CSI Web Server Administrator and the Web Publisher, see the CSI Web Server manual.

2. Requirements CSI Web Server for Linux has the following Linux version requirements.

OS x86_64 Version

Debian 7.0

Ubuntu 14.04

CentOS/RHEL 7.0

Fedora 19 CSIWebAdmin depends on the libgtk, libpng, and csiwebserver packages. If these packages are not already installed on your Linux system, please install them.

3. Installing CSI Web Server for Linux 3.1 DEB Installation (Debian and Ubuntu) 3.1.1 Installing the Web Server 3.1.1.1 Locate the DEB File

Locate the DEB file: csiweb-debian_*_x86_64.deb. The DEB files are located in the root directory of the CSI Web Server for Linux CD-ROM.

3.1.1.2 Log In as a Root User

The dpkg utility requires root privileges on the host computer in order to change the state of the DEB database. You can gain root privileges by using the su or sudo command or by logging in to a terminal as the root user.

CSI Web Server for Linux Installation Guide

2

3.1.1.3 Use dpkg to Install the Software

The following command line demonstrates use of the dpkg utility to install CSI Web Server for Linux:

dpkg --install csiweb-debian_1.5-7_x86_64.deb

The package name contains version and revision numbers, and, therefore, may differ from that shown above.

If you receive dependency error messages from dpkg when installing the CSI Web Server package, you may try to use apt-get with the -f argument to resolve missing dependencies. Example:

apt-get install -f

The dpkg utility can also be used to delete the package by using the following command line:

dpkg --remove csiwebserver

3.1.1.4 Alternatives to the dpkg Command Line

Instead of installing from the command line, most Linux distributions now provide a GUI program that performs the same types of operations. Note that you will still be required to provide the password for the root account in order to use this application.

3.1.2 Installing the Admin Utility

The web server must be installed before the admin utility is installed.

Install the web server admin package:

sudo dpkg --install csiwebadmin-debian_1.5-7_x86_64.deb

The package name contains version and revision numbers, and, therefore, may differ from that shown above.

If you receive dependency error messages from dpkg when installing the web server admin package, you may try to use apt-get with the -f option to resolve missing dependencies. Example:

apt-get install -f

The web server admin package can be removed using the following command line:

sudo dpkg --remove csiwebadmin

To use the sudo command the user must be part of the sudo group. Otherwise, you can use the su command or log in as the root user to install the web server admin package.

NOTE

NOTE

NOTE

NOTE

CSI Web Server for Linux Installation Guide

3

3.2 RPM Installation (Red Hat) 3.2.1 Installing the Web Server 3.2.1.1 Locate the RPM for Your Distribution

Locate the RPM file: csiweb-redhat_1.5-7_x86_64.rpm. The RPM files are located in the root directory of the CSI Web Server for Linux CD-ROM.

3.2.1.2 Log In as a Root User

The RPM utility requires root privileges on the host computer in order to change the state of the RPM database. You can gain root privileges by using the su command or by logging in to a terminal as the root user.

3.2.1.3 Use RPM to Install the Software

The following command line demonstrates use of the RPM utility to install CSI Web Server for Linux:

rpm --install csiweb-redhat_1.5-7_x86_64.rpm

The package name contains version and revision numbers, and, therefore, may differ from that shown above.

If you receive dependency error messages from RPM when installing the CSI Web Server package, you may try to use yum to install. Yum will install the CSI Web Server package and attempt to download missing dependencies. Example:

yum install csiweb-redhat_1.5-7_x86_64.rpm

The RPM utility can also be used to upgrade an already installed version by replacing the --install option with the --upgrade option on the command line. The utility can also be used to delete the package by using the following command line:

rpm --erase csiwebserver

3.2.1.4 Alternatives to the RPM Command Line

Instead of installing from the command line, most Linux distributions now provide a GUI program that performs the same types of operations. On CentOS, for instance, the Package Manager application can be accessed by clicking the Add/Remove Software item on the Applications menu. Note that you will still be required to provide the password for the root account in order to use this application.

3.2.2 Installing the Admin Utility

The web server must be installed before the admin utility is installed.

Install the web server admin package:

rpm --install csiwebadmin-redhat_1.5-7_x86_64.rpm

NOTE

NOTE

CSI Web Server for Linux Installation Guide

4

The package name contains version and revision numbers, and, therefore, may differ from that shown above.

If you receive dependency error messages from RPM when installing the web server admin package, you may try to use yum to install. Yum will install the web server admin package and attempt to download and install all missing dependencies. Example:

yum install csiwebadmin-redhat_1.5-7_x86_64.rpm

The RPM utility can be used to upgrade an already installed version by replacing the --install option with the --upgrade option on the command line.

The utility can also be used to delete the package by using the following command line:

rpm --erase csiwebadmin

4. What the RPM/DEB Installs Installing the CSI Web Server for Linux RPM or DEB results in the following actions:

Copies binary executables and user documentation to the /opt/CampbellSci/CsiWebServer directory.

Copies configuration files to the /etc/opt/CampbellSci directory.

Copies daemon init scripts to directories appropriate for your distribution and registers the csiwebd daemon so that it will start automatically when the host operating system boots.

Ensures that the CSI Web Server working directory at /var/opt/CampbellSci/CsiWebServer is created.

5. Usage Notes 5.1 Starting and Stopping the Web Server

The easiest way to start and restart the web server is by clicking on its icon on the CSIWebAdmin Status tab. Clicking on this icon will toggle the started state of the server. Alternatively, the web server can be started and stopped from the command line.

The server can be started or stopped using the daemons init script as follows:

/etc/init.d/csiwebd start

/etc/init.d/csiwebd stop

Note that these commands must be run with root privileges. Alternatively, some distributions provide a service manager GUI application to start and stop daemons.

NOTE

CSI Web Server for Linux Installation Guide

5

5.2 Launching the CSIWebAdmin Package The CSIWebAdmin package can be launched using the application launcher found at /usr/share/applications/CSI Web Server Admin.

5.3 Changing the Web Server Configuration File 5.3.1 Location of the Web Server Configuration File

The web server looks for its main configuration file, config.xml, in the sys subdirectory of its application directory. If the web server cannot find a configuration file, it will generate its own default configuration and write it at the specified directory. By default, the configuration file is:

/var/opt/CampbellSci/CsiWebServer/sys/config.xml

5.3.2 Organization of the Configuration File The configuration file is in XML format. Its root element is expected to have the name, CsiWebServer. This element does not expect any attributes but it does expect to contain an http-settings child and can optionally contain a log- settings element child.

5.3.2.1 http-settings Element

This element describes the configuration settings for the HTTP server. The following attributes are required:

service-port This attribute specifies the TCP port on which the HTTP server will offer its service. This value will default to TCP port 80 (the default port for the HTTP protocol).

home-dir This attribute specifies the directory that the HTTP server will use as its root. If specified as an empty string (the default), the home directory will default to the application working directory.

The http-settings element has a child element, https that will specify the configuration of the HTTPS server stack. This child element must have the following attributes:

enabled A boolean value that will specify whether the HTTPS stack is enabled for the web server.

service-port Specifies the TCP port on which the web server will accept HTTPS connections.

key Specifies the path to the file that contains the HTTPS private key.

password Specifies the password which is needed in order to decrypt the HTTPS private key.

cert Specifies the path to the file that contains the HTTPS certificate.

CSI Web Server for Linux Installation Guide

6

5.3.2.2 log-settings Element

The server can be optionally configured to track its progress in one or more baled log files. This feature is enabled when there is log-settings element in the server configuration. This element recognizes the following attributes:

mode Specifies the mode that will be used to control how log files are written by the server. The following values are recognized for this attribute: disabled--Specifies that log files will not be created. time--Specifies that the log files will be baled based upon the passage of time and the interval specified by the interval attribute. size--Specifies that the log files will be baled based upon the size of the file and the maximum size specified by the bale-size parameter.

dir This attribute specifies the directory where the log file(s) will be kept. If not specified or is specified as an empty string, this attribute value will default to the application working directory.

file This attribute specifies the base name that will be used when generating log files. If this attribute is not specified or is specified as an empty string, then it will default to csiwebd$.log. The dollar sign character in this string marks the part of the name that will get changed when the log file is baled.

interval This attribute specifies the interval, in milliseconds, at which the log files will get baled. If this attribute is not specified, it will default to a value of 86400000 (one day in milliseconds). The server will not honor any interval that is less than 10 seconds (it will clamp it to this minimum interval). This parameter will be ignored unless the mode attribute is set to time.

bale-size This attribute specifies the maximum size, in bytes, that the active log file will be allowed to reach before baling occurs. It will be ignored unless the mode attribute is set to size.

bale-count Specifies the maximum number of baled files that will be kept by the web server before the oldest baled file is overwritten during a baling event.

report-headers Specifies that HTTP headers that are sent or received should be written in the log files. This can be a useful troubleshooting tool but can increase the amount of data logged per web transaction dramatically.

5.3.3 Editing the Configuration File The configuration file can be edited using CSIWebAdmin as explained in Section 1, CSI Web Server Administrator, in the CSI Web Server manual. Alternatively, the config.xml file can be edited directly using a text editor.

CSI Web Server for Linux Installation Guide

7

5.3.4 Configuration File Auto-Update When the web server reads the configuration file, it will also save the date/time when that file was last changed. It will check the file approximately every fifteen seconds to see if the file has changed since the last time that it was read. If it has changed, the server will read the file again and reinitialize itself with its contents.

5.4 Security Users and their website access rights are controlled through .csipasswd files.

Each user can be given one of the following access levels (the numbers in parentheses are used when editing the configuration file manually):

None (0) No access is allowed. The account is disabled.

Read Only (3) Allowed to view data. No values can be changed.

Read/Write (2) Allowed to view data, make changes to writeable values in a datalogger Public or Status table or a virtual data source, and set a datalogger clock.

All (1) Allowed to view data, make changes to writeable values in a datalogger Public or Status table or a virtual data source, set a datalogger clock, use the API FileControl command, and publish websites.

Section 3.1, PC Websites, in the CSI Web Server manual explains how to create and edit .csipasswd files from CSIWebAdmin or the Web Publisher. The csipasswd command can be used from the command line to edit the .csipasswd file.

Adding a User

In order to add a user with csipasswd, invoke the command as follows:

/opt/CampbellSci/CsiWebServer/csipasswd --password=johnspasswd --access=1 /var/opt/CampbellSci/CsiWebServer/.csipasswd john

This command will add an account named john with a password of johnspasswd and an All access level.

Changing a Users Password

In order to change the password for an existing user, invoke the command as follows:

/opt/CampbellSci/CsiWebServer/csipasswd --password="johnsnewpasswd" /var/opt/CampbellSci/CsiWebServer/.csipasswd john

This command will change the password for user john to johnsnewpasswd

CSI Web Server for Linux Installation Guide

8

Changing a Users Access Level

In order to change the access level for an existing user, invoke the command as follows:

/opt/CampbellSci/CsiWebServer/csipasswd --access=3 /var/opt/CampbellSci/CsiWebServer/.csipasswd john

This will assign a Read Only access level to the account john

Deleting an Account

In order to remove an account with csipasswd, invoke the command as follows:

/opt/CampbellSci/CsiWebServer/csipasswd --delete /var/opt/CampbellSci/CsiWebServer/.csipasswd john

Changing the Realm String

In order to change the realm string specified in the .csipasswd file, you can use the --realm= option as follows:

/opt/CampbellSci/CsiWebServer/csipasswd --realm="New Realm" /var/opt/CampbellSci/CsiWebServer/.csipasswd

5.5 Command Line Options Advanced Linux administrators may have reasons to modify the provided init scripts, create their own, or use other methods for launching the daemon. The csiwebserver executable supports the following command line options:

--AppDir=path: Controls the location where the server will look for its configuration file and will also control the default location of the web server home directory as well as its log files. If this option is not specified, the value will be read from the registry. If not specified in the registry, it will default to /var/opt/CampbellSci/CsiWebServer.

--run-option= : Standalone specifies that the program will run within the console from which it was started. In this mode, it will write its log events to the stdout device. This mode is very useful for debugging and/or troubleshooting. Daemon is the default if the run-option option is not specified on the command line and will make the program run as a daemon. This will force the program to fork (create another process) and then stop. The forked process will close its stdio handles and then execute as a daemon.

Campbell Scientific Companies

Campbell Scientific, Inc. 815 West 1800 North Logan, Utah 84321 UNITED STATES

www.campbellsci.com info@campbellsci.com

Campbell Scientific Africa Pty. Ltd. PO Box 2450

Somerset West 7129 SOUTH AFRICA

www.campbellsci.co.za cleroux@csafrica.co.za

Campbell Scientific Southeast Asia Co., Ltd. 877/22 Nirvana@Work, Rama 9 Road

Suan Luang Subdistrict, Suan Luang District Bangkok 10250

THAILAND www.campbellsci.asia info@campbellsci.asia

Campbell Scientific Australia Pty. Ltd. PO Box 8108

Garbutt Post Shop QLD 4814 AUSTRALIA

www.campbellsci.com.au info@campbellsci.com.au

Campbell Scientific (Beijing) Co., Ltd. 8B16, Floor 8 Tower B, Hanwei Plaza

7 Guanghua Road Chaoyang, Beijing 100004

P.R. CHINA www.campbellsci.com info@campbellsci.com.cn

Campbell Scientific do Brasil Ltda. Rua Apinags, nbr. 2018 Perdizes CEP: 01258-00 So Paulo SP

BRASIL www.campbellsci.com.br vendas@campbellsci.com.br

Campbell Scientific Canada Corp. 14532 131 Avenue NW Edmonton AB T5L 4X4

CANADA www.campbellsci.ca dataloggers@campbellsci.ca

Campbell Scientific Centro Caribe S.A. 300 N Cementerio, Edificio Breller

Santo Domingo, Heredia 40305 COSTA RICA

www.campbellsci.cc info@campbellsci.cc

Campbell Scientific Ltd. Campbell Park

80 Hathern Road Shepshed, Loughborough LE12 9GX

UNITED KINGDOM www.campbellsci.co.uk sales@campbellsci.co.uk

Campbell Scientific Ltd. 3 Avenue de la Division Leclerc

92160 ANTONY FRANCE

www.campbellsci.fr info@campbellsci.fr

Campbell Scientific Ltd. Fahrenheitstrae 13

28359 Bremen GERMANY

www.campbellsci.de info@campbellsci.de

Campbell Scientific Spain, S. L. Avda. Pompeu Fabra 7-9, local 1

08024 Barcelona SPAIN

www.campbellsci.es