## OpenLiteSpeed Web Server Users' Manual

### Version 1.8 — Rev. 12

- License
- Introduction
- Installation
- Administration
  - Service Manager
  - Real-Time Stats
- Security
- Configuration
  - Server General
  - Server Log
  - Server Tuning
  - Server Security
  - External Apps
  - Fast CGI App
  - Fast CGI Authorizer
  - LSAPI App
  - Servlet Engine
  - Web Server
  - Piped logger
  - Load Balancer
  - Script Handler
  - App Server Settings
  - Module Configuration
  - Listener General
  - Listener SSL
  - Virtual Host Templates
  - Virtual Host Basic
  - Virtual Host General
  - Virtual Host Security
  - Virtual Host SSL
  - Rewrite
  - Context
  - Static Context
  - Java Web App Context
  - Servlet Context
  - Fast CGI Context
  - LSAPI Context
  - Proxy Context
  - CGI Context
  - Load Balancer Context
  - Redirect Context
  - App Server Context
  - Module Handler Context
  - Web Socket Proxy
- Web Console
  - Admin Console General
  - Admin Console Security
  - Admin Listener General
  - Admin Listener SSL

# WebAdmin Console - Service Manager

The Service Manager acts as a control room for monitoring the server and controlling certain top-level functions. It provides the following features: (The Service Manager can be accessed by clicking on the Actions menu or from home page.)

- Monitor the current status of the server, listeners, and virtual hosts.
- Apply configuration changes with a graceful restart.
- Enable or disable a particular virtual host.
- View the server log through the log viewer.
- Monitor real-time server statistics.

## Table of Contents

### Name - Server⇑

#### Description

The unique name that identifies this server. This is the Server Name specified in the general configuration.

### PID⇑

#### Description

PID (Process ID) of the current server process.

#### Tips

The PID will change each time the server is restarted.

### Actions⇑

#### Description

Six actions are available from this menu: Graceful Restart, Toggle Debug Logging, Server Log Viewer, Real-Time Statistics, Version Manager, and Compile PHP.

- Apply Changes/Graceful Restart restarts server process gracefully without interrupting requests in process.
- Toggle Debug Logging turns debug logging on or off.
- Server Log Viewer allows you to view the server log through the log viewer.
- Real-Time Statistics allows you to view real-time server status.
- Version Management allows you to download new versions of LSWS and switch between different versions.
- Compile PHP allows you to compile PHP for LiteSpeed Web Server.

#### Tips

The shell utility $SERVER_ROOT/bin/lswsctrl can be used to control the server processes as well, but requires a login shell.

### Apply Changes/Graceful Restart⇑

#### Description

By clicking Graceful Restart, a new server process will be started. For Graceful Restart, the old server process will only exit after all requests to it have been finished (or the Graceful Restart Timeout (secs) limit has been reached). Configuration changes are applied at the next restart. Graceful Restart will apply these changes without any server downtime.

#### Tips

Graceful restart takes less than 2 seconds to generate a new server process.

### Server Log Viewer⇑

#### Description

The Server Log Viewer is a convenient tool for browsing the current server log to check for errors or problems. The log viewer searches the server log file in blocks for the specified log level. The default block size is 20KB. You can use the Begin, End, Next, and Prev buttons to navigate a large log file.

#### Tips

The size of a dynamically generated page is limited by Max Dynamic Response Body Size (bytes). So if the block is too big, the page might be truncated.

### Real-Time Statistics⇑

#### Description

The Real-Time Statistics link leads to a page with a real-time server status report. This is a convenient tool to monitor the system. The report shows a snapshot of your server statistics. The refresh rate for this snapshot is controlled by the Refresh Interval drop-down list in the upper righthand corner. The report contains the following sections:

- Server Health shows the basic server statistics, uptime, load, and anti-DDoS blocked IPs.
- Server lists current traffic throughput, connections, and requests statistics.
- Virtual Host shows request processing statuses and external application statuses for each virtual host.
- External Application lists the external applications currently running and their usage statistics. The CGI daemon process lscgid is always running as an external application.

Many of the rows in the Real-Time Statistics feature a graph icon. Clicking on this icon will open a graph of that row's statistics updated in real-time. In the Server section, next to Requests, there is a link labeled (Details). This link takes you to the Requests Snapshot, where you can view detailed information on which clients are making certain kinds of requests or which aspects of your site are bottlenecking. The fields in the blue area allow you to filter the snapshot to isolate certain parts of your server or look for clients that are performing certain actions.

### Toggle Debug Logging⇑

#### Description

Toggle Debug Logging toggles the value of Debug Level between NONE and HIGH. As debug logging has an impact on performance and can fill up the hard drive quickly, so Debug Level should usually be set to NONE on a production server. This feature can be used instead to turn debug logging on and off quickly in order to debug a problem on a production server. Debug logging turned on or off in this way will not change anything shown in your server configurations.

#### Tips

Toggle Debug Logging will only work if Log Level is set to DEBUG. Important! Debug logging includes detailed information for each request and response. Active debug logging will severely degrade service performance and potentially saturate disk space in a very short time. This feature should only be used for a short period of time when trying to diagnose server issues.

#### See Also

Debug Level, Log Level

### Name - Listener⇑

#### Description

The unique name that identifies this listener. This is the Listener Name you specified when setting up the listener.

### Status - Listener⇑

#### Description

The current status of this listener. The status is either Running or Error.

#### Tips

If the listener is in the Error state, you can view the server log to find out why.

### Virtual Hosts Mappings⇑

#### Description

Shows currently established mappings to virtual hosts from a particular listener. The virtual host name appears in brackets and is followed by the matching domain name(s) for this listener.

#### Tips

If a virtual host has not been loaded successfully (fatal errors in the virtual host configuration), the mapping to that virtual host will not be displayed.

### Name - Virtual Host⇑

#### Description

The unique name that identifies this virtual host. This is the Virtual Host Name you specified when setting up this virtual host.

### Status - Virtual Host⇑

#### Description

The current status of a virtual host. The status can be: Running, Stopped, Restart Required, or Running - Removed from Configuration.

- Running means the virtual host is loaded and in service.
- Stopped means the virtual host is loaded but not in service (disabled).
- Restart Required means this is a newly added virtual host and the server has not yet loaded its configuration.
- Running - Removed from Configuration means the virtual host has been deleted from the server's configuration but it is still in service.

### Actions - Virtual Host⇑

#### Description

This field shows buttons to disable, enable, or restart the virtual host. Actions taken on one virtual host do not affect the rest of the web server.

#### Tips

It is good idea to disable a virtual host temporarily when updating its content.

### Enable⇑

#### Description

The Enable action starts up a stopped virtual host. This allows new requests to be accepted.

### Disable⇑

#### Description

The Disable action stops a running virtual host. New requests will not be accepted, but requests being processed will finish as usual.

### Restart - Virtual Host⇑

#### Description

The Restart action causes the web server to load the newest configuration for this virtual host. Requests being processed will finish with the old configuration. The new configuration will only apply for new requests. All changes to a virtual host can be applied on the fly this way.