Sambar Server Configuration


Using the Administration Interface

1. Start the Sambar Server by double-clicking on the Sambar Server icon created during installation. By default, the HTTP server comes up on port 80. No other servers (FTP, NNTP or proxy) are started by default.

2. Open the index.htm file with your browser. This displays the front page of the Sambar Server interface.

3. Click on the Administration Interface link (http://<your-machine>/session/adminlogin?RCpage=/sysadmin/index.stm).

4. When prompted to enter a username and password, specify admin for the username and leave the password blank. Click OK.

5. On the Sambar Server System Administration page, click on the Server Configuration link.

6. The form on the System Configuration page allows you to change the System Administrator's username, the port number on which the server is running, the maximum number of client connections you want the server to support and a number of other server settings.

7. If you change any of the default values, click on the Update System Configuration button. This not only sends the server a command to update its configuration values, but it returns you to the System Administration page. Please note that any changes specified don't actually take effect until the server is restarted.

If you don't want to change any of the configuration values and want to return to the previous page, click on the System Administration icon.

8. To restart the server, click on the System Management link and then click the Restart Server option.

Note: The default location for all HTML files is under the docs directory in the location where the Sambar Server was installed. The file docs/index.htm is the default home page for the server.

Important: For System Administration usage, you should configure your browser to "verify documents every time". This option is a setting in the Netscape Network Preferences panel's "Cache" tab. This setting will help avoid getting cached pages when moving among the System Administration pages.

Additional documentation is available for configuration of MIME types.

Configuring your browser for Proxy Use

Netscape Version 2 & 3

  1. Open the Netscape Navigator Web Browser.
  2. Select the Options menu.
  3. Select the Network Preferences menu item.
  4. Click the Proxies tab.
  5. Select Manual Proxy Configuration radio button and click the view button.
  6. Type localhost in the HTTP Proxy: field and 80 in the port field.
  7. Type localhost in the Security Proxy: field and 80 in the port field.
  8. Type localhost in the FTP Proxy: field and 80 in the port field.
  9. Click the OK button to close the dialog box
For Netscape Version 2 only:

  1. Open the Options menu.
  2. Select the Save Options menu item.

Microsoft Internet Explorer Version 3

  1. Open the Microsoft Internet Explorer Web Browser.
  2. Open the View menu.
  3. Select the Options menu item.
  4. Click on the Connection tab.
  5. Select Connect through a proxy server.
  6. Click on the Settings button.
  7. Type the following settings in the Servers section:
    HTTP:   localhost 	Port:	80
    

    Leave all other field blank.

  8. Click the OK button to close the Proxy Settings dialog box.
  9. Click the OK button to close the Options dialog box.

Editing the config.ini File

1. Open the config.ini file with any editor. Note: the server must be restart for any changes to take effect.

2. Edit

[common]

Log Size The Log Size specifies the maximum size the server.log file is allowed to grow to. Once reached, the log file will wrap to the first line. If set to 0, the log file will grow as large as disk space will allow.
Trace Failures This argument is for tracing processing failures in debug server builds; it must be true or false.
Trace Successes This argument is for tracing processing failures in debug server builds; it must be true or false.
Trace Threads This argument is for tracing processing failures in debug server builds; it must be true or false.
Trace Library Usage This argument is for tracing internal library initialization and and termination; it must be true or false.
Resolve Host Names This boolean instructs the server to perform DNS name resolution on all clients accessing the server. Performing DNS lookups affects the access log, and HOST environment variable. Users are recommended to leave this variable false unless absolutely necessary due to the significane often performance degredation associated with DNS.
Message File Internal messages logged to the server.log file are localized using strings from the messages file.
Log Directory The directory in which to write all log and observation files.
Cookie Tag The HTTP cookie tag to use when maintaining persistent client connections.
Maximum Connections The maximum network connections to allow open at any given time. This number will influence the number of simultaneous HTTP, FTP, HTTP Proxy, SMTP, POP3 and IMAP4 proxy connections supported as well as the number of threads needed by the applications.
Network Read Timeout The maximum time, in seconds, to wait for a read from a client connection before failing. Note: This period must be at least as large the Keep-Alive duration defined for the HTTP protocol.
Maximum Threads The maximum threads to use in processing user requests. This number should be approximately 10 higher than the number of simultaneous user connections permitted.

[server]

Server Version The server version supported by the configuration file.
Observe Log Size The observation log size specifies the maximum size the observe.log file is allowed to grow to. Once reached, the log file will wrap to the first line. If set to 0, the file can grow as large as disk space will allow.
FTP Log Size The FTP log size specifies the maximum size the ftp.log file is allowed to grow to. Once reached, the log file will wrap to the first line. If set to 0, the file can grow as large as disk space will allow.
Maximum FTP Users The maximum FTP users supported by the server (at any one time).
Maximum FTP Upload The maximum size of any single FTP upload. If set to 0, there is no maximum upload size.
System Administrator The name of the system administrator.
Server Port When the Sambar Server starts, it connects to some port and address on the local machine dna waits for incoming requests. The Server Port configuration value indicates which the HTTP server will listen on.
Maximum Connections The maximum client connections permitted by the server. In general, this should be the same or fewer that the Maximum Connections found in the [common] section.
FTP Port The port to listen on for FTP requests on. By default, the FTP port is 21.
SMTP Port The port to listen on for SMTP requests as well as the port to connect to the SMTP Server on. By default, the SMTP port is 25.
POP3 Port The port to listen on for POP3 requests as well as the port to connect to the POP3 Server on. By default, the POP3 port is 110.
IMAP4 Port The port to listen on for IMAP4 requests as well as the port to connect to the IMAP4 Server on. By default, the IMAP4 port is 143.
Trace FTP A boolean (true or false) indicating whether the trace FTP requests. If true, all read/write actions are written to the logs/ftp.log file.
Act As FTP Server A boolean (true or false) indicating whether the server should act as an FTP server. If true, a thread is started at server startup to listen on the FTP Port and process FTP requests.
Act As SMTP Proxy A boolean (true or false) indicating whether the server should act as an SMTP proxy server. If true, a thread is started at server startup to listen on the SMTP Port and form a circuit between the SMTP Server and the client.
Act As POP3 Proxy A boolean (true or false) indicating whether the server should act as an POP3 proxy server. If true, a thread is started at server startup to listen on the POP3 Port and form a circuit between the POP3 Server and the client.
Act As IMAP4 Proxy A boolean (true or false) indicating whether the server should act as an IMAP4 proxy server. If true, a thread is started at server startup to listen on the IMAP4 Port and form a circuit between the IMAP4 Server and the client.
SMTP Server The SMTP server to communicate with then SMTP requests come from clients to the proxy. To act as an SMTP proxy, the client sets the SMTP server to the SMTP proxy server and the proxy server then connects to the SMTP Server defined by this parameter.
POP3 Server The POP3 server to communicate with then POP3 requests come from clients to the proxy. To act as an POP3 proxy, the client sets the POP3 server to the POP3 proxy server and the proxy server then connects to the POP3 Server defined by this parameter.
IMAP4 Server The IMAP4 server to communicate with then IMAP4 requests come from clients to the proxy. To act as an IMAP4 proxy, the client sets the IMAP4 server to the IMAP4 proxy server and the proxy server then connects to the IMAP4 Server defined by this parameter.
Run Watcher A boolean (true or false) indicating whether the server should spawn a watcher daemon to restart the server in the event of a failure. If true, a Watcher Daemon process is started at server startup to ping the Sambar Server periodically. Important: The Watcher Daemon should only be used in conjunction with the Sambar Server Windows GUI executable [server.exe]; never with the NT Service.)
Watcher Timeout The Watcher Timeout specifies how often the Watcher Daemon should ping the Sambar Server. After a failure, the server is terminated and restarted by the Watcher Daemon.
Watcher Server The path, relative to the installation directory, of the Sambar Server executable that the Watcher Daemon should restart in the event of failure.

[http]

Act As HTTP Proxy A boolean (true or false) indicating whether the server should act as an HTTP proxy server.
Trace Requests A boolean (true or false) indicating whether user requests should be logged to the access.log file. Note: /image and /classes requests are never logged.
Trace Agents A boolean (true or false) indicating whether the user's agent (browser) should be logged to the agent.log file.
Trace Referrers A boolean (true or false) indicating whether the referer should be logged to the referer.log file.
Log Format A string (common, combined or performance) indicating the log format style. common indicates to use the common log format. combined is the combined log format specified by NCSA (the referer and agent are appended to the log line). performance is the combined log format with the addition of the page delivery performance time.
Automatic Directory Lists A boolean (true or false) indicating whether to provide a directory listing if no default file is present in the directory.
Automatic Log Rotation A boolean (true or false) indicating whether the HTTP log files should be automatically rotated (monthly).
Enable Keep-Alive A boolean (true or false) indicating whether HTTP Keep-Alive extension should be used. Keep-Alive is an extension to HTTP that allows persistent connections. These long-lived HTTP sessions allow multiple requests to be sent over the same TCP connection.
Allow HTTP PUT A space separated list of the user's allowed to perform the HTTP PUT method. Additional, per-directory security can be implemented using the security.ini configuration file.
Server Side Includes The file extension of files containing Server Side Includes. This file extension cannot be stm which is reserved for Sambar Server dynamic pages.
Default Page The HTML page to use when a client references a directory without specifying a specific file. Note: this may not be an stm file.
Home Page The HTML page to serve when a client references the server without specifying any page (i.e. http://www.sambar.com). This page must be found in the root document directory specified below. This page cannot be a CGI.
Images Directory A secondary directory for serving non-HTML mime types which will not be logged. This directory must be relative to the Sambar Server installation. Important: you cannot have a sub-directory in the Documents Directory that is the same as this directive. In addition, this directive must have a trailing space.
Classes Directory Another secondary directory for serving non-HTML mime types which will not be logged. This directory must be relative to the Sambar Server installation. Important: you cannot have a sub-directory in the Documents Directory that is the same as this directive. In addition, this directive must have a trailing space.
Documents Directory The document directory under which all HTML files must reside. Unless preceeded by a drive letter (i.e. d:/wwwdir) ,the directory is assumed to be relative to the installation directory of the Sambar Server. All HTTP documents must be served from within the Document Directory. This feature is intended guard other parts of a machine from unwanted access. The FTP server is not limited by this restriction, each configured user of the FTP server may have access to a different root location. Future releases of the server may extend the security associated with the Document Directory through aliasing. This directive must have a trailing space.
CGI Directory The CGI directory under which all CGI executables must reside. This directory must be relative to the Sambar Server installation directory. This directive must have a trailing space.
WinCGI Directory The WinCGI directory under which all WinCGI executables must reside. This directory must be relative to the Sambar Server installation directory. This directive must have a trailing space.
CGI Timeout The duration, in seconds, that a CGI or WinCGI is allowed to run before termination.
Keep-Alive Timeout The duration, in seconds, for the HTTP Keep-Alive functionality. If this period is not at least as large as the Network Read Timeout, the connection will be prematurely terminated.
Session Indicator The argument which indicates that the request refers to an RPC method (i.e. http://www.sambar.com/session/help).
Default MIME Type The default mime type to use when the mime type cannot be inferred from the file extension. More information on MIME types is available.
Remote Proxy When acting as an HTTP proxy, a remote caching server can also be used. If the Remote proxy field is non-blank, all HTTP proxy requests will be forwarded to the server configured (typically your ISP's caching proxy). SSL tunneling requests are also directed through the remote proxy (FTP proxy requests are not).
Remote Proxy Port The Remote Proxy server port to connect with when utilizing a remote proxy server.

[events]

Maximum State Attributes The maximum attributes a user may have. Attributes are referenced using the RCS scripting variable, and are used to maintain state about a user for the duration of the login.
Maximum Users The maximum number of logged in users allowed on the system. There is not necessarily a correlation between logged in users and Maximum Connections, as logged in users refers to user handles maintained across HTTP requests.
Timeout Duration The maximum idle time (in seconds) before a logged in client is automatically logged out. Note: should the total number of logged in connections remain low, clients are not logged out immediately upon reaching the timeout limit.
Trace Events Trace all events into the system. This boolean is for debugging purposes only.

[search]

Index Only The file extensions to index when traversing the Documents Directory. This is a space separated list of file extensions. Note: the character ~ can be used to indicate that the server should index files without extensions (plain text).
Index File The name of the index file to use when building the index. Four files are ultimately created in the search directory, with the name specified used as the base. There may be multiple Index File directives in the configuration file, each identifying a search index. Note: Only one index may be rebuilt at a time.
Index Directories A space separated list of the directories within the Documents Directory to index. To index all files and subdirectories within the Documents Directory, a * should be used. Note: directories must be preceeded by a slash (i.e. /foobar).
Valid Characters A list of all characters that may comprise a valid search string. This list may not have any spaces. Only single-byte character sets are supported.

[user-events]

INIT The DLL and function to call during the INIT event.
EXIT The DLL and function to call during the EXIT event.
REQUEST The DLL and function to call during the REQUEST event.
LOGIN The DLL and function to call during the LOGIN event.
LOGOUT The DLL and function to call during the LOGOUT event. Note: Every client that logs in is guaranteed to log out (even in the event of a shutdown), however, once a single LOGIN event is called for a client (even if unsuccessful), all LOGOUT events are called. Care must be taken when cleaning up in the logout handler.
PROFILE The DLL and function to call during the PROFILE request (RCP scripting variable). The maximum length of the buffer passed in for the return data is 256 bytes.
NETCONNECT The DLL and function to call during the a server connection. The IP address and server type are passed as parameters and access is denied to the server if the function returns SA_FAIL.
FTP The DLL and function to call for username/password authentication during an FTP login. The username and password are passed as parameters and the FTP access structure is filled in on a successful login. Access is denied to the FTP server if the function returns SA_FAIL.
HTTPPROXY The DLL and function to call for each HTTP Proxy request. The hostname or IP address and URL being requested are passed as parameters and the proxy request is terminated if the function returns SA_FAIL. For connections where keep-alives are used, only the first request is processed via the HTTPPROXY event handler, subsequent proxy requests on the keep-alive connection are not filtered. If the HTTP proxy is an SSL request (SSL-tunneling), the URL will be NULL as the proxy does not interpret SSL packets.
ENVIRONMENT The DLL and function to call for each environment request. This allows user-defined environment variables to be used withing if/then/else conditional logic or to be passed as parameters to RPC methods. System defined environment variables have precedence over user-defined arguments. The maximum length of the buffer passed in for the return data is 256 bytes.


Copyright 1995 to 1997 Sambar Technologies