Help - Service Settings
 

Server:/
Config:/servers/*/
SettingExplanationDefault /
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 "Service Pause and Resume" page. Yes IntegerR,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. Do not use a directory name that contains a space.

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 to resources within the Resource Editor, 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" for the specified resource. This is most easily achieved through the Directory Tree.

/powerweb/docs TextR,W
Port Your server has many TCP/IP "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.

Some Standard Port Settings
HTTP80
HTTPS443
SMTP25
SSMTP465
POP3110
SPOP3995
FTP21
FTPS(no standard yet)
80 IntegerR,W
Protocol The protocol supported by this server. eg "HTTP/1.0", "FTP", "SMTP" or "POP3". Each client request is specified in similar fashion and is available in the variable "Request:/Protocol". HTTP/1.0 TextR,W

Advanced Settings
SettingExplanationDefault /
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 service that is active can operate on a different IP address and a different port number. 12.34.56.78 TextR,W
AddressRestrict Set to Yes to force the server to accept connections only on the IP address specified by the "Address" setting. Use "No" if you are running a multi-homed server, or if you wish to allow localhost connections too. No IntegerR,W
Admin The e-mail address of the user responsible for administering this server. This address is displayed within notification messages so that users can contact the webmaster with suggestions or problems. WebMaster@xyz.com TextR,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 fully qualified host 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 to specify a fully qualified host 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 TextR,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 TextR,W
QueueLength Defines the size of the incoming request queue for a Service. Setting a low value means that TCP/IP will reject client requests if the server is very busy, instead of queuing them until they can be serviced. The minimum value is 1, and with the current implementation of IBM OS/2 TCP/IP, the maximum value is 5. 5 IntegerR,W
UserDir Each user is allowed their own home directory for files. This parameter specifies the location of the user's directory when a document URL of the format "/~UserName" is requested.

There are two special keywords within this setting:

~ServerRoot is the server root directory
~User is the name of the user within the requested URL

If the ~ServerRoot keyword is not used, and the "UserDir" is not an absolute path name, then the "UserDir" is assumed to be relative to the document root of the current service.

Example 1: the default setting of "~ServerRoot/usr", emulates the Unix method of storing user directories within a totally separate directory structure away from your main HTTP and FTP directories. In this case HTTP and FTP will access a common directory when serving documents starting with a tilde "~", but will access the normal directories when no tilde is used. This setting (just like the default) allows users to have their own HTML directories and update the files in those directories through using FTP.

Example 2: setting UserDir to "~User" and with the FTP document root set to be the same as the HTTP document root, gives both HTTP and FTP access to a common directory structure when serving documents. This allows users to have their own HTML directories and update the files in those directories through using FTP. You then gain the additional advantage of not needing to use a tilde "~" when accessing user sub-directories.

Only the user who owns the directory is permitted write and delete access. This rule is automatic and does not need to be setup manually through access control rules. It cannot be overridden, except by disabling a specific user's home directory by using the User Editor to set that user's home directory to "none".

When a user logs in with FTP, the current working directory is automatically set to their individual home directory.

If this setting is empty, then user directories are disallowed.

~ServerRoot/usr TextR,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).

SettingExplanationData
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. TextA
LastAccept Timestamp of the last accepted connection.
The format is "yyyy/mm/dd hh:mm:ss".
TextR
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".
TextR
LastReset Timestamp of the last time the server was told to reset itself.
The format is "yyyy/mm/dd hh:mm:ss".
TextR
Software The name and version of the server software. Example "PowerWeb/2.01". TextR
Started The timestamp when the server was most recently started.
The format is "yyyy/mm/dd hh:mm:ss".
TextR