Business Cases For
ISPs & MSPs
Integrations & Partners
Getting Started with Ubersmith, Part 1: Installation
Getting Started with Ubersmith, Part 1: Installation
Let's get started!
Thanks for choosing Ubersmith to manage all of your company's billing, sales, and support needs. This article is the first in a series that will help you get up and running with Ubersmith as quickly as possible.
First, we'll assume that you've gone through one of our other installation articles and have Ubersmith loaded on your server. When you go to your Ubersmith URL for the first time, you'll be presented with a screen that looks like this:
Depending on the languages available within Ubersmith and on your Ubersmith host, you will be able to choose a preferred language to run through the installation. For the purposes of the Getting Started guide, we'll use US English (
). When you have selected your language, click the 'Next' button.
This brings you to the first of two system checks to ensure that your system is compatible with Ubersmith. Setup will not proceed if one of these requirements is not met. Correcting the necessary items (installing PHP modules, changing php.ini settings, etc.) and refreshing this page will give you feedback on the current state of your host. When each item is green, it's time to click 'Next' to continue. If you have trouble getting your host to meet the installation requirements, please contact Ubersmith support.
The next system test checks your PHP CLI or CGI (depending on your configuration). Again, if any items appear red or orange, you will need to address them before proceeding with setup. Under some circumstances, your host may be prohibited from running the PHP CLI or CGI directly. This may lead to complications at this step. If you do run into problems, please contact Ubersmith support for advice on how to proceed.
When all the items appear green, click 'Next' to continue.
At this point, you are ready to configure your MySQL® database connection for Ubersmith. You can use the Ubersmith interface to create the database and user if you have MySQL '
' user access. If not, you can create the database using your control panel software (cPanel, InterWorx, DirectAdmin, etc.). If you do not have a means to create a MySQL user and database, you will need to contact your system administrator for assistance. Enter the username, password, and database name into the fields, and click the 'Test Configuration' button. The Ubersmith install wizard will provide feedback on its ability to connect to your database. If the 'Test Configuration' step results in an error, you may wish to verify that your connection details are correct. You can do this by attempting to connect to the database using the MySQL command line client with the same login details. The syntax is:
mysql -u username -p password databasename
If this connection succeeds, but Ubersmith is unable to connect to the database, there may be a problem with PHP's mysql extension. Once the 'Test Configuration' step succeeds, click 'Write INI' to save your database connection details to Ubersmith's
Ubersmith will provide some suggestions on configuration details for your MySQL database. If you desire, you can modify your MySQL configuration to match these suggestions by editing the
file for your MySQL database, and then restarting MySQL. Either way, click 'Next' to continue with Ubersmith setup.
In the next step, Ubersmith will install your database. This step is fully automated, and may take a moment to complete. Once the installation completes sucessfully, click 'Next' to continue.
You will now be able to choose which languages you would like to make available within your Ubersmith instance. In the example above, we have chosen to install US English (
) and Simplified Chinese (
). We have also chosen to make US English the default language for our Ubersmith instance. Once you are happy with your language selection click 'Next'.
The setup wizard will run through two steps to convert existing data to updated formats. For a new install, this is likely not needed, however it is included in the off chance an existing Ubersmith installation needs to be run through setup for a second time. Click 'Next' to progress through both steps; they should return the result 'No conversion required'. In the next step, you will configure the cron scripts that control Ubersmith's daily invoicing and monitoring capabilities.
The cron job installation step will allow you to automatically install the cron jobs that Ubersmith requires, if you desire. If you would rather install them by hand, the necessary commands are included for you to copy and paste as necessary. If you are installing Ubersmith within a shared Control Panel environment, additional instructions will be displayed to assist you in configuring the cron jobs in such an environment. Once you have had Ubersmith configure the cron jobs, or you have configured them yourself, click 'Next' to continue.
Now, you must configure Ubersmith's Support Manager to handle incoming mail and process them as tickets. (Please note: You must have an MTA or mail server installed on your Ubersmith host. We suggest Postfix, however most any mail server will do.) Ubersmith will provide you with a line to add to your '
' file. This alias entry will direct incoming mail into the Support Manager.
If you are using cPanel or other control panel software, additional instructions may be displayed to help you set up a mail forward as opposed to an alias. Once you have configured your mail alias or forward, click 'Next' to continue.
When you signed up for Ubersmith, you should have received an email with your licensing details. Please note that this information is different from
Ubersmith account info (your '
' username and password). If you did not receive an email with licensing details, please contact Ubersmith support and we will be happy to provide them to you.
If you are attempting to access a free trial and you do not know or are having problems with your Ubersmith license credentials, please contact
When you click 'Login', your Ubersmith host will attempt to contact our licensing server at '
'. You should ensure that your Ubersmith host allows outgoing connections to '
' on TCP ports 80 (http) and 443 (https) to ensure your license can be registered. Once your license has been validated, click 'Next' to move to the administrator user creation step.
Provide a strong password for your administrative users. Strong passwords include case changes, numbers, white space, and special characters. When you are satisfied with the configuration of your Ubersmith administrator user, click 'Create Admin' to add the user to the system.
Since it is no longer needed, the setup wizard will instruct you to remove it from your Ubersmith webroot. Removing the directory and clicking 'Done' will initiate a token update. Your Ubersmith instance will communicate with the licensing server and pull down the appropriate details for your Ubersmith instance. Setup is complete, and you can now log in to your new Ubersmith instance!
You have successfully installed Ubersmith, and you are ready to begin streamlining your billing and support operations. Log in using the administrator login details you created earlier in setup.
16 Mar 2010 11:24 AM
This answer was helpful
This answer was not helpful
Add a Comment
If you would like to comment on this entry, please use the form below. Comments may be queued for moderation, and will not be published until approved.
Image Verification Required
Please enter the characters that appear to the right in the space provided. This is just to verify that you are a human.
E-mail Address: (Optional)
-- Entire Support Site --
Add to Favorites
Ubersmith DE Makes Total Infrastructure Automation & Billing Powerful & Super Easy.
Integrations & Partners
Copyright 2002-2011 Ubersmith, Inc. All Rights Reserved.