## OpenLiteSpeed Web Server Users' Manual

### Version 1.7 — Rev. 12

- License
- Introduction
- Installation
- Administration
  - Service Manager
- 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

# Installation/Uninstallation

## Minimum system requirements

- Operating System:
  - Linux(i386): kernel 2.4 and up, glibc-2.2 and up
  - CentOS: 5 and up
  - Ubuntu: 8.04 and up
  - Debian: 4 and up
  - FreeBSD(i386): 4.5 and up
  - MacOSX: 10.3 and up
- CPU:
  - Intel: 80486 and up
  - PowerPC: PowerPC G4
- Memory: 32MB and up
- Disk:
  - Installation: 200MB
  - Runtime: 300MB and up, swapping space depends on usage.

## Installation

Installation must be performed in a command line terminal. For testing purposes, LiteSpeed Web Server can be installed into a home directory by a non-privileged user. For production use, it should be installed into a system directory.

In Mac OS X, the root user is disabled by default. It can be enabled using a series of actions detailed on the Apple website. You can also use the sudo command to install LSWS into a system directory without enabling the root user, but system folders will still only be manipulable by the root user. This means that every time you want to control LSWS from the command line terminal (like when you want to start or stop LSWS), you will have to use the sudo command.

### Installation Steps:

Visit the OpenLiteSpeed Knowledge Base for a list of installation methods.

## Getting Started

1. For detailed information on controlling the server processes, please see the Administration Guide.

   To start the server, simply run [your_install_dir]/bin/lswsctrl start. (To stop it, run [your_install_dir]/bin/lswsctrl stop.)

2. A sample site should be running on the server.

   To access your site, point your browser to http://[address]:8088/, [address] being the IP address or domain name of your web server machine. Use "localhost" if the server is on the machine you are using. "8088" is the default port. If you chose another port for LiteSpeed during installation, use the port you designated.

   A congratulations page linked to other testing pages should load into the browser when pointed to the above address. If not, try testing the WebAdmin Console interface.

3. The default port for the WebAdmin console is 7080.

   Plug http://[address]:7080/, into your browser to go to the WebAdmin interface. (If you changed the port for WebAdmin during installation, use that port instead.)

   Remember that for [address] you can use "localhost" if you're currently using the machine the server is on.

   The WebAdmin welcome page should load. Click the "Log on" link and use the administrator's username and password specified during installation to log on.

   For detailed information regarding configuration, please refer to our Configuration Guide, or click the "Help" link at the top of each page.

4. If your server uses firewall, please make sure that localhost is trusted.

   For instance, Linux with IPTables should include a rule ALLOW INPUT from LO.

5. If your web site and the WebAdmin Console are inaccessible, please take a look at the error log [your_install_dir]/logs/error.log.

   If there is a TCP port conflict with other server applications, the web server should be reinstalled with an available port. The following command can be used to find an available port: netstat -an | grep XXXX XXXX is a port number. If the port is available, the command will produce no output.

   If the swapping directory is not writable, you can either grant writing permission for the swapping directory to the user whom the web server is running as, or change the swapping directory's configurations manually. The swapping directory is configured in the server's XML configuration file: [your_install_dir]/conf/httpd_config.xml. Search the XML file for swappingDir. The default location for the swapping directory is /tmp/lshttpd/swap.

   If you still have problems with installation, please check out our wiki or post your problem on our support forum.

## Notes

- OpenLiteSpeed supports both native LiteSpeed XML configuration files and plain text configuration files (for those used to editing Apache's httpd.conf). Run [your_install_dir]/conf/switch_config.sh to switch between these formats.
- On FreeBSD, Mac OS X, Ubuntu, and Debian, the shipped PHP (for CentOS) will not run. You will need to build a new PHP for OpenLiteSpeed in order to run PHP applications with OpenLiteSpeed.

## Uninstallation Steps

1. Stop OpenLiteSpeed if it is running: [your_install_dir]/bin/lswsctrl stop
2. Remove the install directory: rm -rf [your_install_dir]