Virtualmin Installation Quickstart

This legacy document is here only to insure incoming links continue to work. You likely want to start with the new documentation index or search for what you want to know about. This document is unmaintained!
Table of Contents

    This legacy document is here only to insure incoming links continue to work. You likely want to start with the new documentation index or search for what you want to know about. This document is unmaintained!
    Table of Contents

    A quick overview guide to installation of Virtualmin Professional or Virtualmin GPL and creation of a virtual domain, for users wanting to dive right in. More complete documentation can be found in the Virtualmin Administrators Guide.

    Introduction

    This Quickstart assumes a few things about your environment. If these assumptions don't apply to you, you'll need to fill in the blanks yourself, or refer to the more comprehensive Virtualmin Administrators Guide. This document is designed to help you get a Virtualmin Professional or Virtualmin GPL server running in as little time as possible.

    Assumptions

    OS

    While install.sh supports a number of operating systems, this short guide primarily applies to CentOS. The commands are roughly the same across most supported systems (except FreeBSD, where a higher level of knowledge is required of the administrator). See our OS support page for details about systems supported by the install script.

    All systems in a simple Server installation (no extra packages, none removed, during installation)

    Partitions One big / partition containing everything (except swap and /boot)

    Network Operational, with a fully qualified hostname, reliable DNS and reasonable bandwidth

    Note: You must have a fully qualified hostname configured on your system. This is not optional, and failure to configure a fully qualified domain name on the system before or during installation will lead to "localhost" being used in numerous locations which simply will not work for a production server. We recommend using a third level domain name like ns1.virtualmin.com, or primary.example.com, or vm.domain.tld, since this insures Postfix virtual maps don't overlap with the hostname of the system.

    Copying the Install Script

    The first step, after downloading your system installation script from the Virtualmin.com license management page, or downloading the Virtualmin GPL install.sh, is to get it copied over to your new server. scp is the simplest method.

    % scp install.sh root@new.server:

    Other methods are FTP, NFS, and SMBFS. They are left as an exercise for the reader.

    NOTE: There are many tools that support scp or fish (ftp over ssh), including some that provide a Windows or Mac OS X GUI. You don't have to use a command line client to utilize a secure and reliable protocol like ssh. Examples include WinSCP and CuteFTP. Use of scp is recommended instead of traditional FTP.

    You can also use wget to download the script directly to your server. An example one-liner to download and execute your install.sh is listed in your serial numbers page. Likewise, you can download the Virtualmin GPL install script using wget with the following command:

    % wget http://software.virtualmin.com/gpl/scripts/install.sh

    NOTE: Though similar, Virtualmin GPL is not the same product as Virtualmin Professional. If you have purchased Virtualmin Professional, you should use the install.sh provided on your serial numbers page so that you get all of the features of the Professional product.

    Run the Install Script

    Login to your new server as root, either via ssh or directly on the console, and run the following commands:

    # /bin/sh install.sh

    This will perform a few checks of your system to hopefully help insure the installer will be able to complete successfully. If you get any errors during these checks (like you forgot to set a fully qualified domain name for your server as mentioned above), simply correct the problem and try again. Further along in the script, if something goes wrong, it will attempt to clean up enough for the script to be run again. The last line of output in the even of a failure will tell you whether the cleanup has occurred.

    NOTE: If installation is unsuccessful, review the events that led up to the failure and let us know what went wrong at the Virtualmin.com bug tracker. You can then remove the virtualmin-release package (rpm -e virtualmin-release), and try again (after attempting to correct whatever was broken). If installation of Virtualmin Professional does not succeed on a fresh installation of any supported OS and version, we will install it for you at no charge. Simply file a private ticket in the ticket tracker, with a brief explanation of the problem.

    Checking the configuration

    Assuming the installation ran without any errors and to completion, you can now login to Webmin on port 10000 using the https protocol. For example:

    https://new.server:10000

    Now, click the "Re-check and Refresh Configuration" button at the top of the right hand content page, and watch for errors. If it completes with the line "your system is ready for use by Virtualmin", your installation was successful and you can begin creating domains, or customizing your configuration! If not, let us know in the Virtualmin forums or bugs and issues tracker, and we'll try to help you resolve any problems that occurred.

    Creating your first domain

    Now that you've successfully installed Virtualmin Professional (way to go!), you can create a new domain. You're already logged into Virtualmin from the previous step, so now just locate the *Create Server* menu item in the left-hand menu. Click it to open up the menu, and then click the *Create Virtual Server* item. This will open a new page in the right-hand content window where you can fill in the necessary data for your new server.

    When creating a new domain, there are just a few items that have to be provided, while everything else is optional and will be filled in with default values (based on your configuration, and selected Server Template). The required fields are:

    Domain Name: It's value should be apparent, but it's worth mentioning that you should leave off the www. It will get prepended automatically for the website address (while mail will get mail.domain.name).

    Adminstration password: Here you have a choice. You can have a password randomly generated, or you can enter one yourself. If you have one generated, you *must* provide a valid email address for the domain setup email to be mailed to, otherwise no one will know the password!

    Believe it or not, you're done. Click the button labeled "Create Server" and sit back to watch Virtualmin perform a fabulous array of configuration on your system automatically. Assuming all goes well (and it probably will), you'll have a fully functioning website with mail, database, DNS, anti-virus, anti-spam, Webalizer and AWstats reporting, disk quotas, and a whole lot more! If something went wrong, by some unlikely sequence of events, please let us know about it.

    And that concludes this Quickstart Guide. You did great. Now you're ready to dig in and customize your Virtualmin Professional installation. Check out the comprehensive online help (click on any option to get a popup help window), the Virtualmin Administrators Guide, or come chat with us in the forums at Virtualmin.com.