Installation/Uninstallation
Minimum system requirements
- Operating System:
Linux(i386): kernel 2.4 and above, glibc-2.2 and above
Solaris(Sparc): SunOS 5.8 and above
Solaris(x86): Sun0S 5.8 and above
FreeBSD(i386): 4.5 and above
MacOSX: 10.3 and above
Open Darwin: 7.0 and above
- CPU:
Intel: 80486 and above
Sun: UltraSPARC and above
PowerPC: PowerPC G4
- Memory:
32MB and above
- Disk:
Installation: 10MB
Runtime: 20MB and above, swapping space depends on usage
Installation Steps
Installation must be performed in a command
line terminal. For testing purpose, LiteSpeed Web Server can be installed into
your home directory as a non-privileged user. For production use, it should
be installed into a system directory. Under Mac OS X, root
user is disabled by default; it can be enabled by using the NetInfo
Manager Application in /Applications/Utilities
folder. If you don't want to enable root user, you can use "sudo" to install
LSWS into a system directory as well.
- decompress the package into a convenient location:
tar xvfz lsws-xxxx.tar.gz or gunzip
-c lsws-xxxx.tar.gz | tar xvf -
- [Enterprise/VPS Edition Only] Install license key
or serial number.
- Install trial license. Trial license is for evaluation purpose and
is only good for 30 days upon download. It will be sent to you as an
attachment in the confirmation email upon your evaluation request.
Please save the attachment as "trial.key" and copy
to the installation directory.
If you are switching from a trial license to a purchased license, please
follow the steps below to get your license key and run Installer
again to update your license.
- Production licensing procedure:
- Each order is assigned with one serial number and the number of allowed installation.
- The serial number will be sent to you as an attachment in the confirmation
email after you order has been successfully processed.
- Save the serial number as a file named "serial.no" and copy to the installation directory.
- Run the Installer. Installer will generate a license key request and send to LiteSpeed products registration server and get a license key file automatically. If the process failed due to whatever reason, the Installer will leave the license key request file in the same directory. You can email the license request file to register@litespeedtech.com and request manual process.
- After a valid license key file (named as "license.key") available in the installation directory, you can run Installer to continue installation.
- License transfer procedure:
Please be aware that the license key is associated with the serial number
and the server's hardware signature. A new key is required if changes
of hardware signature is detected. So in case you upgrade your hardware or change your hardware, you need to transfer your current production license in order to continue using the product in the new hardware.
- To migrate your current license, you can simply run the server binary ./lshttpd -m. It will talk to LiteSpeed products registration server to unlock your serial number and generate a temperate license key. This temperate key is good for 3 days. So this allows you a smooth transition to the new hardware without any service disruption.
- In your new hardware, go to installation directory, which should contain the same serial number file "serial.no". Run the Installer to get the new license key. Since your serial number has been unlocked in the previous step, you will get a newly assigned license key.
- If the process failed due to whatever reason, you can email your current license key file and the new license request file to register@litespeedtech.com and request manual process. A small amount of migration fee will be charged for manual process.
- After a valid license key file (named as "license.key") available in the installation directory, you can run Installer to continue installation.
- Go to the installation directory cd lsws-xxxx
and run command ./install.sh
The "root" user can install the server into a system directory; other users
should install it to somewhere under his home directory.
Mac OS X user can install the server into a system directory with command
sudo ./install.sh
- Read the End User License Agreement and type "Yes" to confirm your agreement.
- [Enterprise/VPS Edition Only] Generate license request.
If the Installer only finds serial number but no valid license key, it will
prompt to generate a license request. The installer will talk to LiteSpeed products registration server and obtain a valid license key automatically. Upon getting the license key, it will go to next step. If failed, the installer will exit and leave a license request file.
If the automatic process failed, you need to manually register. The generated request lic_req.bin should be e-mailed
to register@litespeedtech.com.
A new license key will be sent back to you in email shortly after we receive
you request, please save it to the installation directory and run the Installer
again.
Note: Installation will continue only if there is a valid/trial license.
- Follow the instructions on the screen.
The following questions will be asked:
- User and group that the server process run on behalf of.
- Destination directory where the server should be installed.
- If an installed copy exists, choose either Update or Reinstall.
Update will keep your current configuration.
- Administrator's user name and password for the administration web interface.
- TCP port for normal web service.
- TCP port for web administration interface.
- [Enterprise/VPS Edition Only] "root" user has
option to enable "chroot". The installer will setup the initial chroot
environment automatically. Chroot is an advanced feature and your CGI
may fail without configuration tuning. We strongly recommend not enabling
it unless you are familiar with "chroot". You can always enable it later
with an upgrade installation.
"root" user can also choose to run LiteSpeed web server as a service which
starts automatically at system startup.
Server can be started by the installer once it is installed successfully.
Testing Installation
- There are a couple of ways to control the server process. For detail information
please see Administration Guide. To start the server,
simply run [your_install_dir]/bin/lswsctrl start.
- If the default port for normal web service was not changed during installation,
point your browser to http://[address]:8088/, otherwise
replace "8088" with actual port used. "[address]" should be the IP address
or domain name of web server machine. Use "localhost" if it is accessed from
the same machine. The congratulation page should be loaded into browser, if
it is not, try next step.
- If the default port for web administration interface is not changed during
installation, point your browser to http://[address]:7080/,
otherwise replace "7080" with actual port used. "[Address]" should be the
IP address or domain name of your web server machine. Use "localhost" if it
is accessed from the same machine.
The welcome page of administration interface should be loaded, click "Log
on" link and use the administrator's user name and password specified during
installation to log on. For detailed information regarding configuration,
please refer to our Configuration Guide, or click
"help" link on top of each page.
- 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.
- If the web administration interface is inaccessible either, please take
a look at the error log - [your_install_dir]/logs/error.log
- If it is because of TCP port confliction 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 the port number. If the port is available, no output should be
produced.
- If it is because swapping directory is not writable, you can either
grant write permission of swapping directory to the user whom the web
server running as, or change the swapping directory manually.
The swapping directory is configured in the server's XML configuration
file located at [your_install_dir]/conf/httpd_config.xml,
default value is /tmp/lshttpd/swap. Search for
<swappingDir>.
If you still have problem with installation, please read the up to date Trouble
Shooting first. Post your problem on our support Forum
if you cannot find an answer.
Upgrade
There are a few scenarios that you need to update or upgrade the server
- A new release is available
- Upgrade from Standard Edition to Enterprise/VPS Edition
- Upgrade from a trial license to production license
- Upgrade production license from N CPU to M CPU license.
To upgrade to another edition/release, just run install.sh again and select 'upgrade', your current configuration will be kept.
Since release 2.0, the built-in update agent will check new release periodically and automatically download new package and send email notification about the new release. Server upgrade can be performed via the web admin interface by clicking the upgrade link in the version management page.
For license upgrade, you can manually copy "serial.no" and "license.key" to [your_install_dir]/conf/ directory then restart, it is recommended to backup your old license key first.
Version Management
- Since release 1.5.6, multiple versions of LiteSpeed web server can be installed
and easily switched from one to another by using the version management utility
provided [your_install_dir]/admin/misc/mgr_ver.sh.
- To switch to version A, for example 1.5.6, just run [your_install_dir_current_version]/admin/misc/mgr_ver.sh
1.5.6
- To remove previous installed files for version A, for example 1.5.6,
just run [your_install_dir_current_version]/admin/misc/mgr_ver.sh
-d 1.5.6
- Since release 2.0, version management is available from WebAdmin interface
under "Service Manager - Server - Version Management". It will list all the
installed versions and available new releases. You can install new release
or switch between different versions by just a click.
Uninstallation Steps
- Simply run [your_install_dir]/admin/misc/uninstall.sh
and follow the instructions on the screen.
- The following questions will be asked:
- whether to keep the log directory
- whether to keep the configuration directory
- All the directories that are not created by the Installer will not be touched,
even they are under [your_install_dir]. But all the files created by the Installer
will be removed.
- [your_install_dir] will be removed as well if it is empty.