## Help

### Server:/ Config:/servers/*/
Setting | Explanation | Default / Example | Data Type | Access R,W,A,D
--- | --- | --- | --- | ---
AutoStart | Set to TRUE to cause PowerWeb to load this service upon startup. If it is set to FALSE, the service must be manually started through the system console. | Yes | Integer | R,W
DocumentRoot | The default directory from which to serve documents or files. When the client requests a resource, it is always relative to this drive and directory. This is a very simple and effective security mechanism. Users cannot access documents outside of the document root directory tree, unless you specifically define aliases to map URLs to those locations. VERY IMPORTANT: If you change this directory, be sure to modify any relevant paths under "Security/Resource", otherwise you will not be able to access the documents. To redirect a client request to another drive or directory outside of the "DocumentRoot" directory, use an "Alias" variable for the specified resource. If no drive is specified, the current drive when the server is loaded is used. | /powerweb/docs | Text | R,W
> Port | Your server has many "ports" which it uses to distinguish how to process incoming client requests with different protocols. You can pick any number from 1 to 65535, but make sure no other service is using it. It makes sense to tell your server to listen on standardised port numbers, because using a non-default port affects your users. For example, if your HTTP server runs on port 8000, users will need to use a URL similar to "http://www.widget.com:8000" to access your server.
> Standard Port Settings
> HTTP | 80
> HTTPS | 443
> POP3 | 110
| 80 | Integer | R,W
Protocol | The protocol supported by this server. eg "HTTP/1.0", "FTP" or "POP3". Each client request is specified in similar fashion and is available in the variable "Request:/Protocol". | HTTP/1.0 | Text | R,W

### Advanced Settings

Setting | Explanation | Default / Example | Data Type | Access R,W,A,D
--- | --- | --- | --- | ---
Address | The server's address in numeric IP form. For a symbolic name for the address, use the "Host" variable. Note that each separate server that is active can operate on a different IP address and a different port number. | 12.34.56.78 | Text | R,W
Admin | The E-mail address of the user responsible for administering this server. | WebMaster@xyz.com | Text | R,W
Host | This is the server's address in text form. The numeric IP address is contained in the "Address" variable. Set this variable in the Configuration editor if you wish to override the automatic DNS lookup and provide an alternative alias name for your site. PowerWeb uses the name you give here as the main Uniform Resource Locator (URL) when users access your site. The server name is built from your domain name, and the name of your server. You must include both your domain name and the machine name. Your system administrator may have already set up a Domain Name Server (DNS) alias for your server such as `www.widget.com`. If so, then you should use that alias. If not, you should use the machine's name combined with your domain as the name. For example, if your machine was named `server`, and you were part of the domain `widget.com`, you would use the server name `server.widget.com`. | www.widget.com | Text | R,W
ErrorFile | The name of the file to which error messages should be sent. The Error Log server hook can be used to store error messages in alternative formats and destinations such as a database server. | http.err | Text | R,W
UserDir | Under UNIX, each user is allowed their own home directory for files. This parameter specifies the name of the directory under their home directory from which their documents will be served when a URI of the format /~UserName is received. | web-docs | Text | R,W

### API Settings

Introduction

Each server is given its own sub-directory underneath the global "Config:/Servers/" directory. When a server hook is called, the relevant sub-directory corresponding to the current server is passed over as an argument.

This means that the server data is accessible through two different paths. The one relates to the current server that is requesting the hook to perform an action, and the other allows a hook global access to all servers (typically used for remote administration or statistics to allow a summary of all activity to be presented).

Setting | Explanation | Data Type | Access R,W,A,D
--- | --- | --- | ---
ErrorOutput | Any text written to this variable is automatically directly output to the log, after which the variable is emptied. | Text | A
LastAccept | Timestamp of the last accepted connection. The format is "yyyy/mm/dd hh:mm:ss". | Text | R
LastIdle | Timestamp of the last time the server entered an idle state (had no connected client). The format is "yyyy/mm/dd hh:mm:ss". | Text | R
LastReset | Timestamp of the last time the server was told to reset itself. The format is "yyyy/mm/dd hh:mm:ss". | Text | R
Software | The name and version of the server software. Example "PowerWeb/2.01". | Text | R
Started | The timestamp when the server was most recently started. The format is "yyyy/mm/dd hh:mm:ss". | Text | R