Introduction

The CYWare JS API provides a convenient way to create web applications with the ease of javascript coding, coupled with the speed of a natively compiled engine.

The engine itself consists of only three files: a common library file, a settings file and a binary CGI file. A web server and database are also required.

JS API Files

Filename Location Description
libcyware (.so, .dylib, .dll) /usr/local/lib CYWare library containing common functions for the JS engine
cyweb.cgi Web server CGI directory The CGI binary that reads script files and produces HTML output
cyweb.cgi.ini /usr/local/cyware/ini The settings file in Windows INI format.

INI file Entries

The settings file has the following keys:

Key Description
PORT The web server port.
TIMEOUT The web session timeout value in seconds.
TITLE The web page title.
VERSION The CYWare JS API version number.
EXTLIB The CYWare library extension: .so for Linux, .dylib for OsX, .dll for Windows
... TODO: Not yet done... 
                    SAMPLE INI FILE  
                    ===============
                    
                    
                    [GENERAL]
                    PORT="443"
                    TIMEOUT="600"
                    TITLE="Simple POS"
                    VERSION="-2.0.0"
                    EXTLIB=".so"
                    HOST="olm"
                    DOMAIN="socialwifi.tv"
                    ACTION="/cyware/cyweb.cgi"
                    
                    [LOG]
                    LOG="true"
                    TRACE="true"
                    SYSLOG="true"
                    
                    [PATH]
                    LIBROOT="/usr/local/lib
                    DOCROOT="/usr/local/cyware/web/"
                    JSROOT="/usr/local/cyware/web/"
                    
                    [RETAIL]
                    PORT="3306"
                    TYPE="mysql"
                    HOST="localhost"
                    USER="root"
                    PASS="F042437300900077C5"
                    NAME="osxloyalty"