Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
hiddentrue

Installation steps and common issues.


Table of Contents
Table of Contents
maxLevel5
minLevel2
outlinetrue
classtoc



Tip
titleSoftaculous Auto Installer

Does your server have Softaculous installed? If so, you may alternatively install Blesta through Softaculous.

Installation

Follow these steps to install Blesta on your server.

1. Download Blesta

Visit https://account.blesta.com/client/plugin/download_manager/client_main/ and click to download the latest version.

2. Unzip the Archive

Unzip the Blesta archive (.zip) file using your favorite compression utility. On Windows, right click and select "Extract All". If the zip is uploaded to or downloaded directly to a Linux server, run the following in your shell:

Code Block
languagebash
unzip blesta-vx.x.x.zip
3. Upload Files & Launch Installer

Upload the contents of the blesta directory to your server where you will be accessing Blesta. Before you continue any further, ensure you've created a database that Blesta can be installed into. You'll need your database host (usually localhost), database name, database user, and database user password to continue with installation.

Blesta may be installed in one of two ways, either via the web in your browser, of via command line.

Web Installation

Follow these steps to install Blesta via the web.

  1. Point your web browser to the location where you uploaded the contents of blesta (e.g. https://yourdomain.com/path_to_blesta/).
  2. Follow the on screen instructions to complete installation.
  3. Once installation completes, you'll be prompted to create your administrator user and enter your license key or start a free trial.
Command Line Installation

Follow these steps to install Blesta via the command line.

  1. In a shell, cd to the directory you uploaded the contents of blesta.
  2. The CLI installer can be run in interactive mode, or non-interactive mode by passing parameters.
    1. For interactive mode run 

      Code Block
      php ./index.php install


    2. For automatic mode run

      Code Block
      php ./index.php install -dbhost DATABASE_HOST -dbname DATABASE_NAME -dbuser DATABASE_USER -dbpass DATABASE_PASS -hostname WEBSITE_HOSTNAME


      ParameterDescription
      -dbhostThe database hostname (usually localhost)
      -dbnameThe database name
      -dbuserThe database user
      -dbpassThe database password
      -hostnameThe website hostname. For example, billing.domain.com. The is the hostname where Blesta will be accessed from. If not set, will attempt to detect the hostname from server configuration, which in many cases will not be accurate.


  3. Once installation completes, direct your web browser to https://yourdomain.com/path_to_blesta/admin/ to create your administrator user and enter your license key or start a free trial.

Once completed, you'll be logged in for the first time automatically. For subsequent logins, see Logging In. You may also want to enable Two-Factor Authentication.

Info
titleLicense Information

If you do not have a license key, you will be able to activate a free trial during the installation process directly. If you have previously purchased a license key, you will be able to enter it during the installation process. You may obtain a license directly from us at www.blesta.com, from one of our resellers, or directly from your hosting provider. Version 2 license keys are not compatible with version 3, so if you only have a version 2 license key you will need to request a version 3 key for each version 2 license you hold.

Widget Connector
width654
urlhttp://player.vimeo.com/video/62845736
height409

4. Set up a Cron Job

Once installation is complete, a cron job must be created to automate tasks within Blesta. Go to [Settings] > [System] > Automation, and copy the "Cron Command", for use in creating a cron job on your server. Most hosting control panels provide an easy way to create cron jobs, follow the documentation for your control panel to complete this important step. The cron job should run every 5 minutes. Once the cron has been configured, verify that the status icon turns green and displays the last time run on the System Automation page within Blesta.

Note

If using a control panel to configure the cron, you may not need to copy the first part of the cron command "*/5 * * * *" which designates that the cron run every 5 minutes. Your control panel may ask for schedule information separately. Please also note that your path to PHP may be different, as it can vary from server to server. On some cPanel servers, the path is /usr/local/bin/php

 

Info
titleCron Emails

The cron outputs information about the tasks it is running, and your cron daemon may email your cron user the output of your Blesta crons. To disable that, you can append the following to the end of your cron command: " >/dev/null 2>&1" (remove quotes)


Info
titleRunning the cron via the web

Using CLI is always recommended, but the cron may be run by accessing https://www.yourdomain.com/blesta/install/path/cron/?cron_key=CRONKEY where CRONKEY is your cron key as displayed under "Update Cron Key"

wget method
/usr/bin/wget -O /dev/null -q https://www.yourdomain.com/blesta/cron/?cron_key=CRONKEY

If you do not have mod_rewrite, the URL will need to include index.php, for example: https://www.yourdomain.com/blesta/install/path/index.php/cron/?cron_key=CRONKEY where CRONKEY is your cron key as displayed under "Updated Cron Key".

System Configuration

There are a number of configuration settings that may be set before or after installation.

Requiring index.php in URLs

By default Blesta does not include index.php as part of any URL request, thanks to the use of .htaccess mod_rewrite rules. If your server does not support mod_rewrite Blesta requires index.php to be included in all URLs. To force Blesta to include index.php in all URLs simply rename or delete the .htaccess file included with Blesta in your root web directory.

Info
titleDoes your server support URL rewriting?

If so, you may be able to enable pretty URLs by creating the appropriate web server config, and modifying the /lib/init.php file to set define("HTACCESS", true);

Changing the path to the Admin area

By default the path to the Admin area begins with /admin/. To change this locate routes.php in /installpath/config/routes.php and modify the value of the "Route.admin" configuration. For example, to change the path of the admin area to /staff/ set the following:

Code Block
languagephp
titleroutes.php
Configure::set("Route.admin", "staff");
Changing the path to the Client area

By default the path to the Client area begins with /client/. To change this locate routes.php in /installpath/config/routes.php and modify the value of the "Route.client" configuration. For example, to change the path of the client area to /customers/ set the following:

Code Block
languagephp
titleroutes.php
Configure::set("Route.client", "customers");
Forcing HTTPS

If your server supports mod_rewrite, you can enable HTTPS redirects by uncommenting the following lines (remove the '#' symbols) from the .htaccess file included with Blesta.

Code Block
title.htaccess
#RewriteCond %{HTTPS} !=on
#RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [R=307,NE,L]

Common Installation Issues

Errors

  • Connection FAILED. Ensure that you have created the database and that the credentials are correct.
    • Check to ensure the hostname, database name, user, and password you entered are correct and try again.
    • If the credentials are correct you may have MySQL old_passwords enabled. Disable old_passwords for your database or update your user's password:

      Code Block
      languagebash
      % mysql
      % SET SESSION old_passwords=0;
      % SET PASSWORD FOR 'username'@'localhost' = PASSWORD('password');


  • Call to undefined function crypt_random() on line 1660 in /home/user/blesta/vendors/phpseclib/Crypt/RSA.php
    • The line number and path may be different. This error has most commonly been seen with Nginx installations. The issue has to do with a missing include_path in php.ini.
    • Edit your php.ini to add the include_path to your PHP binary.
    • Please see this forum thread for more details on this issue, and to download a test script to confirm whether your server is affected by this issue.
  • The email failed to send due to a configuration issue. Occurs when trying to send an email, and email is configured correctly.
    • Disable SELinux (Via SSH run as root "echo 0 > /selinux/enforce" Then, so that it remains off after boot, edit /etc/sysconfig/selinux and set SELINUX=disabled
    • If you MUST run SELinux (not recommended) you can run the following command instead "setsebool -P httpd_can_sendmail 1"
  • Mod rewrite is not enabled, or htaccess is not supported by this server.
    • Make sure mod_rewrite is loaded in Apache and that AllowOverrides is set to All in your httpd.conf for your virtualhost
    • Make sure MultiViews is disabled in your virtualhost in httpd.conf. (If you receive this error and the URL in your browser is ~/install/ this is almost certainly the issue)
  • Cron does not work, outputs error "Undefined variable: argv on line"...
    • Edit your php.ini file and set register_argc_argv to "on". Restart the web server.
    • If running CloudLinux, you may need to edit the php.ini for alt-php. The location of the php.ini will be something like: /opt/alt/php54/etc/php.ini (Note the version php54, php55, etc) Then, run the following command to rebuild: cagefsctl --rebuild-alt-php-ini
  • I get a white page at /settings/company/billing/invoices/ after upgrading to version 4
    • Remove ~/helpers/html. This directory was removed in v4 and may be causing the issue. You might also see the error "Cannot declare class Html, because the name is already in use in ..."
  • I get an "Undefined index: total" or "Error while sending QUERY packet" or "PDOStatement::execute(): send of 113 bytes failed with errorno=32 Broken pipe"
    • It's possible max_allowed_packets and/or wait_timeout values are too low in your MySQL config. Edit /etc/my.cnf (default location) and set max_allowed_packets to a value of 128M or higher, and wait_timeout to a value of 3600 or higher.

IIS

  • Submitting data reloads the current page
    • There is an issue with your web.config file. Try the following web.config file:

      Code Block
      <?xml version="1.0"?>
      <configuration>
         <system.webServer>
            <rewrite>
               <rules>
                  <rule name="Main Rule" stopProcessing="true">
                     <match url=".*" />
                     <conditions logicalGrouping="MatchAll">
                       <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                       <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                     </conditions>
                     <action type="Rewrite" url="index.php" />
                  </rule>
               </rules>
            </rewrite>
         </system.webServer>
      </configuration>

      Next, update /lib/init.php and make the following change:

      Code Block
      // define("HTACCESS", file_exists(ROOTWEBDIR . ".htaccess"));
      define("HTACCESS", true);


Cron Issues

  • Cron does not seem to complete normally and Settings > Company > Automation shows some hung tasks.
    • Try disabling your cron job, and running the cron manually under Settings > System > Automation. If it runs correctly, you may have a memory issue in your CLI environment with Zend Memory Manager. Some users have reported that appending export USE_ZEND_ALLOC=0; to the beginning of their cron job resolved the issue. When using this method, your cron may look something like this: export USE_ZEND_ALLOC=0; /usr/bin/php /home/user/public_html/blesta/index.php cron

License Validation Issues

  • License does not seem to validate. I've confirmed that port 443 egress is open at my firewall at Curl SSL is installed.
    • Make sure mbstring.func_overload is off in your php.ini. Overloading single byte functions with mbstring functions will prevent encryption from working properly and your license will not validate.
    • Make sure that System.debug is set to false in your ~/config/blesta.php config file (Blesta 4.0+ only). It should appear as: Configure::set("System.debug", false);