In general and at a high level, the installation procedure is as follows.

We use the GitHub infrastructure to download the latest version of coreBOS available and also to keep our system updated (as we will see later) and activate the installation process from our favorite browser (we recommend Firefox). From that point on, the process will be guided by the Installation Assistant, who will present the steps and ask us the necessary questions to complete the task.

The basic steps are as follows:

  1. Download the source code from GitHub (https://github.com/tsolucio/corebos)

  2. Copy the code into a folder accessible from the Apache web page server

  3. Access with your browser by entering the address or URL of the folder from the previous point.

  4. You will access the Configuration Assistant that will guide you to the end.



* Always get the latest version of the coreBOS code, as it changes very frequently.

* Have access to the database access data

* Run coreBOS Update just behind the installation

* Configure and check operation of scheduled tasks (Cron or similar)


In the next point, we show the process with more details and screenshots for those who need more help at this point.


At this point, we assume that you have correctly installed and configured the software necessary for coreBOS to work. Specifically, Apache with PHP and MySQL. We will assume that Apache is serving pages from the /var/www directory, this will be the root directory of Apache or our web server. In other words: any page with HTML that we create in this directory and its subdirectories will be accessible from a browser.

Download the code from GitHub

Our first step is to create a subdirectory at the root of the webserver and copy it within the coreBOS code.

There are two ways to get the code from Github. On the main page of the project ({URL}), we find the download button that will give us a compressed file in zip format with the latest version of the code at that time. We can decompress this file and upload all the content to the webserver within a subdirectory. This is not the recommended method since once the code is downloaded it is not linked to the project, it is only a photo at any given time. However, many times, depending on the access we have to our server is the only thing that can be done.

The recommended way to copy the code to the server is by using git. Git gives us a simple tool to manipulate the code and keep it updated. In return, it requires us to have access to the command line and / or learn to use the tool, even if only in a very basic way.

Copy of the code to a folder accessible by the browser.

From the command line, we will be located in the root directory of the webserver and execute the git command necessary to get the coreBOS code.

git clone https://github.com/tsolucio/corebos cbinst

This will create a "cbinst" directory (or another name) with a copy of the entire project at that time. The advantage is that this copy is linked to the project and any changes we make can be applied with a few steps from now. We will see this later.

Browser access to the installation wizard

The next one is to make sure that the Apache server has sufficient permissions to work with the application. To do this you must find out the server user, usually www-data in Linux and we will ensure that the entire subdirectory has WRITING permission for this user.

Now we can launch the installation wizard by accessing the directory created by git, doing HTTP: // {your server} / cbinst

Running CoreBOS Installation Wizard

The assistant will present us with a welcome screen that will allow us to choose between installing or migrating (The migration is to convert versions of Vtiger CRM before 5.4, an option that we will not cover here) coreBOS.

By pressing the install button we reach the screen that contains the application license, which we must accept as we accept all these licenses :-)

Upon accepting the license, the wizard will perform a series of checks on the installed software and server permissions. If we have done the previous steps of server configuration and permissions, then all the indicators in green will appear on this page; otherwise, we will find something like this:




and once everything is configured correctly, we will see it like this:




The first installation configuration screen contains all the necessary data:

  • access to the database,

  • Currency

  • password of the first administrator user




If we enter all the data correctly, we will validate the data and access the database system. If there is an error, the assistant will inform us of it as seen in the following image.




And if all the data is correct, we will present a final confirmation screen, after which the installation will be carried out and we will arrive at the completion screen.




Installation Image successfully completed.




From this screen we can already access our coreBOS at the same address we used to install:

https: // {your server} / cbinst

The application realizes that the installation has already been done and presents the access screen. At the moment there is only one user-created who is the administrator user with the password you provided during installation. If you didn't change it there it will be: admin

Admin Manual
Developer Manual