Getting Started with Kloxo

Kloxo is a light-weight control panel that is both memory friendly and powerful. It has all
the features included in all leading control panels such as mail, spam filter, PHP, CGI,
Perl, SUexec, FTP, MySQL and much more. This guide is meant to get you started with
Kloxo and explain the basic features needed to get your website up and running.

Logging In
There are several ways to access Kloxo:

1. By clicking the "Kloxo" tab through HyperVM (no login required)

2. http://192.168.0.1:7778 or https://192.168.0.1:7777 - You can access the control
panel through any IP address allocated to the server. This is useful when your
domain transfer has not yet propagated. (replace 192.168.0.1 with your VPS's IP
address)
3. http://yourdomain:7778 - You can access the control panel through any hosted
domain by putting :7778 at the end of the domain. (non-SSL)
4. https://yourdomain:7777 - You can access the control panel securely using SSL
through any hosted domain by putting :7777 at the end of the domain.

A login window will appear. Enter your username (admin) and password and you should
have successfully logged in.

We recommend the first thing you do is change the admin password for Kloxo. You can
change the password by clicking on the "Password" icon in the Administration box
towards the top of the page. Enter your current password in the first field and your new
password in the remaining boxes. Then click "Update"
After you change your password return to the main screen by clicking "Home" tab.

Pop-up Notifications
Kloxo will remind you of particular settings you should update using a pink colored pop-
up box. You will notice different messages based on the area of Kloxo you are using. It
is a good idea to follow the links provided to setup the particular section Kloxo is
warning you about. Pop-ups will include contact information, setting up lxguard, setting
a mail server identity, changing the default SSH port, and possibly one on setting up a
default DNS template. They look like the following:

Extra Help
After clicking on most icons, a red/orange outlined box of information on using a
particular feature is usually present. These boxes are located at the bottom of the page
below the options. This includes information on how to use the feature as well as how to
configure it. An example can be found below:
Navigation through Kloxo
Navigation through the various Kloxo options is done in two primary locations. The first
option is the Tree View found in the upper-left corner.

By clicking the “+” next to each option you can navigate through the various options.
Each item shown has an equivalent icon on the middle section of the page. The "Client",
"Server" and "File" options will be explained in greater detail later in the document.

The second set of tabs you will see are located in the center window and are used for
options that are available for your current screen
Another method of navigation Kloxo uses are called "breadcrumb" trails. These appear
just above the second set of tabs and provide navigation for your most recent choices.
They are only present if you have navigated through several screens.

Kloxo takes advantage of one other navigation option in the top right corner, just above
the "Tree View" portion of the page:

Due to the many options for navigation in Kloxo getting around can sometimes be a bit
daunting. If in doubt, click the "Home" icon - which is the first icon shown in the picture
above to get back to the main screen. Most options you need to use regularly are found
in three places:

1. The "Home" screen which can be reached by clicking the large blue "Home" icon
2. The "Server" screen which can be reached by clicking the "Servers" option in
Tree View
3. The "Domains" area which can be reached by going to the "Home" screen then
clicking the "Domains" tab.

Selecting Default Programs

By default Kloxo uses the following programs for web services:

 Web server – lighttpd

 Spam filter – bogofilter
 DNS – djbdns

You can change the default programs by clicking the "Switch Program" icon in the
Server:linux box on the home screen. Most people are more familiar with Apache as the
web server and Spam Assassin as the spam filter. You can switch to one or both of
these from the Switch Program screen. We recommend you change your default
programs BEFORE you setup any domains, assuming you want to switch default
programs.

NOTE: You have the ability to run your own nameservers within Lxadmin. You are free
to do so but configuring them is not covered in this document. We recommend you use
the DNS features through HyperVM. Instructions can be found here:
DNS with Kloxo
With Kloxo you can chose to run your own nameservers, which enable you to have
custom DNS records like "ns1 and ns2.mydomain.com" or you can use the DNS servers
we provide for VPS customers.

 The main benefits to using Kloxo's built in DNS options is you can manage all DNS settings
through Kloxo and create custom nameservers. This allows easy management of all
domains you create in Kloxo. The downsides are setup can be a bit confusing and
troubleshooting is more difficult if you run into DNS issues.
 If you do not use Kloxo's DNS option you will need to create zone files through HyperVM
once you add a domain through Kloxo. The HyperVM option requires no additional setup
through Kloxo and "just works". You may find that although this method adds a bit of
overhead to domain management it may be the easier choice in the long run.

The remainder of these instructions are related to Kloxo's DNS offering.

To get started click on the "DNS Templates" icon from the home screen.

Then click the "Add DNS Template" tab and you will be presented with the following
screen:
Fill in the information as defined above. ns1 and ns2.yourdomain.tld should be replaced
with the domain you want to use for your name servers, Example: ns1 and
ns2.ilovea2hosting.com

Click the "Add" button when you are done. You will be returned to the main DNS
Templates screen. From here you can edit your templates by clicking on the name in
the list. In order for these nameservers to work you will now need to register your
nameservers at your domain registrar.
Setting up a Website
You have probably noticed that Kloxo has a lot of icons to click on. We will not cover every
option available but feel free to click around once you have the basics under your belt. We will
start by setting up your domain to resolve to your VPS and touch on the necessary options to
fully configure a domain.

NOTE: Before you start setting up your domain in Kloxo we highly recommend you configure
your DNS to point to your VPS. If you need to keep your domain pointed elsewhere until your
data is moved keep in mind that certain features like e-mail and webmail will not work properly
until your DNS is updated. To setup your DNS (zone files) please skip ahead to the "DNS with
Kloxo" section then come back to this point when you are done.

Adding your Domain (creating the website)

To add your domain to your VPS make sure you are on the Home screen. You can assure this by
clicking on the "Home" icon in the top left of the screen.

On the Home screen you will see a "Resources" box, click on the "Add Domain" icon to get
started.

NOTE: If you have not yet setup DNS you will see a pink notification box asking you to setup a
DNS template. Skip down to the "DNS with Kloxo" section for instructions on creating one. You
must do this before it will allow you to create domains, even if you aren’t going to use Kloxo's
DNS options.

After clicking on "Add Domain" you will be taken to the following screen:
Enter your domain name WITHOUT the 'www' in the first text box. In the second box you can
name the directory for your site. Using the domain name is generally a good idea to help keep
your sites organized, especially if you are planning on having more than one site. Below the text
boxes are various options you can enable or disable for the domain. Generally you can leave the
default options selected. Once you have entered your domain name, folder name and
selected/deselected options click the "Add" button in the bottom right corner of the box. You will
ee the domain you created below once you click the add button. This is the same screen you can
reach by clicking the "Domains" tab at the top of the main window. We will cover the
"Domains" tab in more detail after the following FTP section.

Uploading your Site Data (FTP, SFTP, File Manager)

By default you can always login to manage all of your domains with the "admin" FTP account.
This account exists by default and does not need to be created. When you login using the
"admin" FTP user you will be dropped into the /home/admin directory of your VPS. This
directory contains the folders for all of your domains.

To connect using FTP you can use your favorite FTP client - we recommend FileZilla - and your
Kloxo "admin" login information; the same username/password you use to login to Kloxo. If you
are not familiar with FTP please see our Knowledge Base article at the following URL:

Connecting to Your Account Using FTP

To create an FTP user that is only allowed access to a specific folder first click the "Home" tab to
get back to the main screen. The under the "Domain" heading click the FTP users icon.
You will see that a default user has been created for each domain you have added. If you would
like to add a new user, click the "Add FTP User" tab at the top of the window.

You can create a username only account by leaving the dropdown menu next to user set to
---direct--- or you can create an FTP user for your specific domain by entering the username and
then selecting your domain from the drop-down menu. The username would then be in the
"user@domain" format. This is useful if you are hosting more than one domain. You can then
enter the password and the starting directory for the user. The user will not be able to view
folders below the starting directory you set. This way you can limit users to specific folders and
domains. You can also set the upload limit in MB (megabytes) that a user can upload to a
directory. Once you have selected the required options click the "Add" button at the bottom of
the box.

If you would like to use SFTP – the Secure File Transfer Protocol – it is possible. SFTP is
preferred because it provides a secure connection from your computer to the VPS server. The
main limitation is the ease of setup and the users that can connect using this method. Only users
with shell access can connect using FTP and by default only the root user has shell access. You
can easily change this for the admin user by doing the following:
Click the "Home" tab at the top of the screen then click the "Shell Access" icon in the Resources
box.

It will take you to the screen below:

You can then select the shell type from the dropdown box. /bin/bash is "normal" shell and
/usr/bin/jailshell is a more restricted type. Once you select the shell type click the "Update"
button. You can then connect to your VPS using the SFTP protocol. For detailed instructions on
using SFTP to connect see the following Knowledge Base article:

Connecting to your site using SFTP

NOTE: You will not be able to connect with SFTP using normal FTP users. Only accounts with
shell access - usually limited to your "admin" user - can connect using SFTP.

Using either FTP or SFTP you can upload your files to your website. You will need to place your
files in the folder you created when setting up your domain. Usually /home/admin/<domain>

Using the File Manager for File Uploads

If you would rather upload your files through the Kloxo interface you can do so using the File
Manager.

From the Home screen locate the File Manager icon under the "Domain" heading and click on it.
You will be taken to the File Manager which defaults to the /home/admin directory. You should
see folders that match the names of those you created when you added a domain. You can see an
example below:
The Domains Tab
To control and view options for each domain – options like e-mail accounts, parked domains,
traffic history, statistics, mailing lists, PHP configuration – you will use the "Domains" tab at the
top of the page.

By clicking on the "Domains" tab you will be taken to a list of all domains you have created on
the server. You may have to look below the Add Domain form to see the list of domains. You
can hide the Add Domain form by clicking "Click Here...(Show/Hide)". A set of quick access
icons for each domain are shown to the left of each domain name; you can hold the mouse over
each icon to see its purpose when logged into Kloxo.

To view all options for a particular domain, click on the name of the domain. You will then be
taken to the 'Domain Home' for that particular domain. All of the options that follow are found
on the domain home page which is accessed by clicking on the name of the domain from the
Domains tab.

E-mail accounts
To add an e-mail account enter the 'Domain Home' for the domain you want to work with. Scroll
down to the "Mail : qmail" box and click "Add Mail Account"

You will be taken to a screen where you can enter the e-mail address you wish to create, setup
the account password as well as set a mailbox size limit. After filling in the necessary fields,
click the "Add" button at the bottom of the box. After clicking "Add" you will be taken to the
general e-mail options for your domain. Here you can modify SPAM settings, select your
preferred webmail application, setup mailing lists and view all e-mail accounts. By clicking on
the "Mail Accounts" icon you can further customize each addresses SPAM settings, limits and
filters.

You can use a standard mail application such as Outlook or Thunderbird to check your mail or
you can use the webmail applications included in Kloxo. To connect to your webmail you can
use the following URL: http://webmail.yourdomain.tld/(replacing "yourdomain.tld" with your
domain name). This URL will only work if you have setup DNS through Kloxo or HyperVM
(the subdomain entry is created automcatically). If you are using outside DNS you will need to
add an "A" record for this entry.

Ruby on Rails
If you plan on running Ruby on Rails application on your Kloxo VPS it is definitely possible.
The default template has Ruby, Rails and Gem installed but at this time does not work as
intended with the Kloxo interface.

We have anticipated the need for Ruby on Rails support and have created another template pre-
loaded with Apache and mod_rails (aka, Passenger) that works wonderfully with RoR
applications. You will need to rebuild with the "centos-5-i386-kloxo-passenger" template in
order to use Passenger. Passenger is memory efficient, fast, and a breeze to setup. If you are not
familiar with Passenger you can view more information at the Passenger website:

http://www.modrails.com

All of the pre-configuration for Passenger has been completed for you and you just need to
follow the simple directions found below to setup a rails application:

NOTE: This requires you use the Linux shell on you VPS server. We have pre-configured most
things so you will simply need to add a few lines to a particular file.

Log into the Linux shell on your VPS and open the following file with your favorite text editor
(vim, nano, etc.)

/etc/httpd/conf/kloxo/rails.conf

Add the necessary lines based on the instructions provided in the link below, restart Apache
("service httpd restart") and that's it – you've got Rails!

Domain logs and Site Stastics

You can check logs for your domain by using the icons in the "Traffic & Log" box. By clicking
on the icon that correlates to the service you want to check. These logs are extremely useful
diagnostic tools when you are experiencing a problem with your site.

Several other boxes and icons are present for each domain but are not covered here. They are
normally fine at their default values. If you need to make modifications to things like the PHP or
Apache configuration we will assume you have the knowledge and skills to do so.

It is recommended you click the "Stats Page Protection" icon and set a password to access your
stats.
Other Useful Features
Kloxo has many other features that are very useful. Some of the more common and frequently
used features are explained below and include assigning a site a dedicated IP address, setting up
and SSL certificate, using the "Files" tab and a brief discussion of clients and resellers you can
create on your VPS.

Please provide the reason for needing the additional IP address in your ticket. We keep
documentation on all IP requests to prevent usage that is against our Terms of Service. If you
have used all of your available IP you can request additional IP address through the ticket
system. Current pricing is $3 per IP per month but is subject to change.

Assigning a Dedicated IP address to your Site

To assign a dedicated IP address to your site, log into Kloxo. From the Home screen click the
"Ipaddresses" icon in the "Resources" box.

After clicking on the icon you will be taken to a screen that lists all IP addresses assigned to your
VPS. Click on the IP address you wish to assign to a particular domain. You will then be taken to
the options screen for that IP address.
Click the "Configure Domain" tab at the top of the page. You will then be presented with
something like the following:

Use the drop-down menu to select the domain you wish to assign to the IP address listed in the
box above then click "Update".

NOTE: If you have not yet updated DNS for your domain you will receive an error message like
the following:

Alert: To map an IP to a domain, the domain must ping to the same IP, otherwise, the domain
will stop working. The domain you are trying to map this IP to, doesn't resolve back to the IP,
and so it cannot be set as the default domain for the IP.

If you would like to assign your site a dedicated IP BEFORE you update DNS you can do so by
adding the following line to /etc/hosts

'192.168.1.1 domain.tld'

You can either edit the file directly or issue a command such as the following:
'echo "192.168.1.1 domain.tld" >> /etc/hosts'

(make sure you use two ">>" or you will overwrite the file.)
In both examples remove the single quotes around the outside and replace the '192.168.1.1' with
the IP address you want to assign and "domain.tld" with your domain name.

After you have made this change you can go back and follow the steps for adding the dedicated
IP address listed above and you should not receive the error. You cannot assign a dedicated IP
address to more than one site. If you do not assign a site a dedicated IP address it will "share" the
main IP address on the server by means of virtual hosts in your webserver software
(apache/lighttpd). These will be configured automatically by Kloxo.

Installing an SSL Certificate

Through Kloxo you can install an SSL certificate you have already purchased, create a self-
signed certificate for personal use or generate a "CSR" (certificate signing request) for ordering a
new certificate.

NOTE: In order to install an SSL certificate on a domain it MUST have a dedicated IP address.
Only one SSL certificate can be installed per IP address.

Log into Kloxo and go to the Home screen. In the "Resources" box click the SSL Certificates
icon.

1. Uploading a Current SSL Certificate

1. If you already have an SSL certificate you would like to use click the "Add
Upload File" tab. Give the SSL certificate a name; this can be anything you like.
Click the "Browse" buttons and upload the Key, Certificate, and CA file (if
applicable) then click "Add"
2. Now click the "SSL Certificates" tab and you should see the SSL certificate you
just uploaded in the list.
3. Assign the domain you wish to configure a dedicated IP address (see instructions
above)
4. Click the "Home" tab then click the "Ipaddresses" icon in the 'Resources' box.
5. Click the IP address you assigned to the domain you are installing the SSL
certificate on then click the "SSL Configuration Home" tab.
6. Using the drop-down menu select the name of the SSL certificate you uploaded
previously then click "Update"
7. Kloxo should restart Apache (or lighttpd) automatically but if https:// isn't
working properly you may need to restart it manually.
2. Generating a self-signed SSL certificate
 1. Log into Kloxo and go to the Home screen. In the "Resources" box click the SSL
Certificates icon.
2. Click the "Add SSL Certificate" tab
3. Give the SSL certificate a name and fill in the appropriate information in the
boxes. Please keep in mind that an ssl certificate for "www.domain.com" is
different from just "domain.com" so be sure to specify version of your domain
you want the SSL certificate on. Click the "Add" button once you have filled in
the appropriate information.
4. Assign the domain you wish to configure a dedicated IP address (see instructions
above)
5. Click the "Home" tab then click the "Ipaddresses" icon in the 'Resources' box.
6. Click the IP address you assigned to the domain you are installing the SSL
certificate on then click the "SSL Configuration Home" tab.
7. Using the drop-down menu select the name of the SSL certificate you uploaded
previously then click "Update"
8. Kloxo should restart Apache (or lighttpd) automatically but if https:// isn't
working properly you may need to restart it manually.

The "Files" Tab

You can use the "Files" tab as an alternative to FTP or SFTP to upload or download files to/from
your site. You can also zip files or folders for smaller download, upload files from your home
computer, a remote URL, or remote FTP server (the last 2 are great for transferring your data
from your old hosting account).

The files tab does not require much explanation. Just click on the "Files" tab and use the File
Manager tab to navigate your files then view/download current files or use the Upload tab to add
files to your site. All uploaded files will be placed in "/home/admin"

Clients and Resellers

There are two types of clients; Resellers and customers. The main difference is Resellers can
have customers under them. The smallest unit of authorization in Kloxo is a customer, who can
have multiple domains under them.

In order to setup a Reseller or Client you will need to create a Resource Plan. A resource plan
determines how many clients a reseller can have, how many domains can be hosted, traffic
allowed, disk space allowed and much more.

If you are hosing multiple sites for different clients and wish to give them access to their content
you can add a client login so they can modify their web content but no one else's.

The home directory of a customer is '/home/clientname', and his domain's document root is
/home/clientname/domain.com'. He can also login through ftp using his clientname as the id and
the password.