IPC@CHIP® RTOS-LNX – API Documentation

Header image

Main page


CHIP.INI [WEB]


[WEB]
ENABLE=0/1

Define if the Web server should be activated. Use 0 to disable, 1 to enable.

BIOS_Server_On_Off() may be used to enable the server if disabled at startup due to this CHIP.INI entry.
Default:
If safe mode is off, the Web server is enabled per default. If safe mode is on, the Web server is disabled per default.
Example:
[WEB]
ENABLE=0
Since
V0.80


[WEB]
PRIO=prio

Defines the task priority of the web server task (@WEB). Legal values are in the range 0-90.
Default:
Default is 90.
Example:
[WEB]
PRIO=80
Since
V0.80


[WEB]
MAINPAGE=name of the web server main page

Defines the name of Web server's main page. The Web server opens this page if a browser request like "http://192.168.200.4/" is received. Typical names are "main.htm" or "index.htm".
Default:
Default is "main.htm", which is an internal CGI page.
Example:
[WEB]
MAINPAGE=index.html
Since
V0.80
See also
CGI_SetMainPage()


[WEB]
TEMPPATH=name of a temporary Web server path

Defines a temporary path for finding files. If the Web server cannot find the file in its default directory, it will try to find it in this temporary path. Pathname should include the drive specification. This function allows the Web server to locate HTML files produced on the IPC@CHIP® RAMDISK by application programs. The maximum string length is 32.
Default:
No default.
Example:
[WEB]
TEMPPATH=C:\web
Since
V0.80


[WEB]
DRIVE=disk drive number

Set Web server's disk drive.
     0: Drive A
     1: Drive B
     .............
     5: Drive F
Default:
If the drive does not exist, the default drive A will be set.
Example:
[WEB]
DRIVE=1
Since
V0.80
See also
CGI_SetRootDrive()


[WEB]
ROOTDIR=directory name

Defines the name of Web server's root directory.
Important notice:
To avoid security leaks you should define a directory below the "\\" directory. If you use "\" as web root directory, everybody can read all your files.
Default:
If the directory does not exist, the Web server sets "\" as the default root directory.
Example:
[WEB]
ROOTDIR=\web
Since
V0.80
See also
CGI_SetRootDir()


[WEB]
HTTPPORT=port

Sets the port number of the web server.
Default:
Default HTTP port: 80
Example:
[WEB]
HTTPPORT=81
Since
V0.80


[WEB]
BODY_SIZE=size in bytes

Sets the web server maximum body length in bytes. Minimum allowed value is: 256 bytes.
Default:
Default body length: 32768 bytes.
Example:
[WEB]
BODY_SIZE=60000
Since
V1.02


[WEB]
HTTPVERSION=HTTP version

Configure which HTTP version the web server will use.
     2 = HTTP 1.0 (web server will close the connection)
     3 = HTTP 1.1 (web server will leave the connection open)
Default:
Default is to use the HTTP 1.1 version.
Example:
[WEB]
HTTPVERSION=2
Since
V0.80


[WEB]
DETECT_ENCODING=0/1

If this option is set to 1 (default: 0), static files will be opened to check their first few bytes for a magic signature. Currently only gzip compressed files are supported. If such a file is detected a special content encoding header (Content-Encoding: gzip) will be sent to the HTTP client. The client then knows that the file needs to be unpacked.
By setting this option you can compress any files before putting them onto your chip without having to rename them and thus without having to adapt links etc.
Default:
By default the detection of the encoding is disabled.
Example:
[WEB]
DETECT_ENCODING=1
Since
V0.80


[WEB]
UPLOAD=0/1

Define if the Web server file upload should be activated. Use 0 to disable, 1 to enable.
Default:
By default, the Web server file upload is disabled.
Example:
[WEB]
UPLOAD=1
Since
V0.80


[WEB]
UPLOAD_PATH=name of a Web server path used for HTTP file uploads

Defines the name of Web server's drive and directory used for http file uploads. If the directory does not exist, file uploads will fail.

The path specified here is used when the DESTINATION-PATH form item field is used.

The webstat command shows the current upload path.
Default:
Empty, which means that the web server root drive and directory is used.
Example:
[WEB]
UPLOAD_PATH=C:\uploads
Since
V0.80


[WEB]
UPLOAD_PATH2=additional name of a Web server path used for HTTP file uploads

Defines a second name of Web server's drive and directory used for http file uploads. If the directory does not exist, file uploads will fail.

The path specified here is used when the DESTINATION-PATH2 form item field is used.

The webstat command shows the current upload path.
Default:
Empty, which means that this path is not used.
Example:
[WEB]
UPLOAD_PATH2=C:\uploads
Since
V1.12


[WEB]
UPLOAD_MAX_SIZE=maximal file size in bytes

Define the maximum size for HTTP uploaded files. When the uploaded file exceeds that size it will not be saved. As result the web server returns an server error to the browser. The maximum file size is 4294967295 bytes.
Default:
The default max upload size is 4294967295.
Example:
[WEB]
UPLOAD_MAX_SIZE=4096
Since
V0.80


[WEB]
SECURE=0/1/2

Defines whether the security feature for the Web Server is active or not.
     0 = security feature deactivated
     1 = security feature activated, basic authentication
     2 = security feature activated, digest authentication

The Web Server security feature allows up to ten paths to be protected with user name and password. When this security feature is activated, users must then authenticate themselves to get Web access to these paths.
Note:
Place your CGIs and the upload CGI under these protected paths, if they should be protected.
Default:
Per default the security feature is deactivated.
Example:
[WEB]
SECURE=1
Since
V0.80
Changes:
V1.08 - Add digest authentication mode


[WEB]
SEC_URLx=path

Defines a specified URL for the Web security feature. The user can define SEC_URL0 to SEC_URL9. All sub URLs of SEC_URLx are then protected by user name and password. The SEC_URL0 path is protected by SEC_USER0 user name and SEC_PASSWORD0 password, and SEC_URL1 by SEC_USER1 user name and SEC_PASSWORD1 password, and so on.

The maximum length for the paths is 63 characters.
Default:
No default.
Example:
[WEB]
SECURE=1
SEC_URL0=/sec/
SEC_USER0=otto
SEC_PASSWORD0=web
Since
V0.80


[WEB]
SEC_USERx=user name

Defines a user name for the Web security feature. The user can define SEC_USER0 to SEC_USER9. The max length of the user name is 19 characters.

If the security feature is activated, the user should define a path, user name and password.
Default:
No default.
Example:
[WEB]
SECURE=1
SEC_URL0=/sec/
SEC_USER0=otto
SEC_PASSWORD0=web
Since
V0.80


[WEB]
SEC_PASSWORDx=password

Defines a password for the Web security feature. The user can define SEC_PASSWORD0 to SEC_PASSWORD9. The max length of the password is 19 characters.

If the security feature is activated, the user should define a path, user name and password.
Default:
No default.
Example:
[WEB]
SECURE=1
SEC_URL0=/sec
SEC_USER0=otto
SEC_PASSWORD0=web
Since
V0.80


[WEB]
SEC_REALMx=realm string

Defines a realm string for the Web security feature. The user can define SEC_REALM0 to SEC_REALM9. The max length of the realm string is 259 characters.
Default:
The default strings for are "Secure URL0" for SEC_REALM0 and "Secure URL1" for SEC_REALM1. The other realm strings are empty by default.
Example:
[WEB]
SEC_REALM0=SecurityArea
Since
V0.80


[WEB]
SSL_ENABLE=0/1/2

Defines whether the SSL web server is used or not. IF SSL_ENABLE=1 the SSL web server task is started and running. IF SSL_ENABLE=2 the SSL web server task is started but suspended. In this case the user program must enable the server with BIOS_Server_On_Off().

You have to provide a CA certificate filename, a local server certificate filename and a private and public key pair filename
Default:
The SSL web server is disabled per default.
Example:
[WEB]
SSL_ENABLE=1
Since
V0.80


[WEB]
SSL_DRIVE=disk drive number

Set SSL Web server's disk drive.
     0: Drive A
     1: Drive B
     2: Drive C
     3: Drive D

If the drive does not exist, the default drive A will be set.
Default:
If this entry is not present the normal Web server/s disk drive and root directory will be used.
Example:
[WEB]
SSL_DRIVE=3
Since
V0.80


[WEB]
SSL_ROOTDIR=directory name

Defines the name of SSL Web server's root directory. If the directory does not exist, the Web server sets "\" as the default root directory.
Important notice:
To avoid security leaks you should define a directory below the "\" directory. If you use "\" as web root directory, everybody can read all your files.
Default:
If the SSL_DRIVE entry is not present the normal Web server/s root directory will be used.
Example:
[WEB]
SSL_ROOTDIR=\sslweb
Since
V0.80


[WEB]
SSL_HTTPPORT=port

Sets the port number of the SSL web server.
Default:
Default SSL HTTP port: 443
Example:
[WEB]
SSL_HTTPPORT=8201
Since
V0.80


[WEB]
SSL_HTTPVERSION=HTTP version

Configure which HTTP version the SSL web server will use.
     2 = HTTP 1.0 (SSL web server will close the connection)
     3 = HTTP 1.1 (SSL web server will leave the connection open)
Default:
Default is to use the HTTP 1.1 version.
Example:
[WEB]
SSL_HTTPVERSION=2
Since
V0.80


[WEB]
SSL_VERSION=select supported SSL version

Defines what SSL version the SSL web server should support.
     2 = TLS 1.x
     3 = SSL 3.0 and TLS 1.x
     4 = TLS 1.2 only
Default:
TLS 1.x
Example:
[WEB]
SSL_VERSION=2
Since
V0.80
Changes:
V1.02 - Changed default from 3 (SSL 3.0 and TLS 1.x) to 2 (TLS 1.x)


[WEB]
SSL_CACERT=CA certificate filename

Defines the name of Web server's CA certificate. SSL_CACERT must be the name of the web server's root CA certificate. If needed more Certificates can be put together in one file. Possible file formats are *.PEM and *.DER.
Default:
No default.
Example:
[WEB]
SSL_CACERT=ROOTCERT.DER
Since
V0.80


[WEB]
SSL_ENABLE_CLICERT=0/1

Defines if a Clientcertificate is required. If SSL_ENABLE_CLICERT=1 the Client is asked for a clientcertificate signed by the web servers CA.
Default:
No default.
Example:
[WEB]
SSL_ENABLE_CLICERT=1
Since
V0.80


[WEB]
SSL_SERVERCERT=Filename of the server certificate

Defines the name of Web server's own local certificate. Possible file formats are *.PEM and *.DER.
Default:
No default.
Example:
[WEB]
SSL_SERVERCERT=SRVCERT.DER
Since
V0.80


[WEB]
SSL_KEYFILE=Filename of the server key file

Defines the name of Web server's private and public key file. Possible file formats are *.PEM and *.DER.

Key lengths longer than 4096 bits are not supported.
Default:
No default.
Example:
[WEB]
SSL_KEYFILE=PRIVKEY.DER
Since
V0.80





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Tue Dec 12 2017 09:23:36 by Doxygen 1.8.13