3.3 - Install ProcessMaker in Ubuntu 18.04

Overview

Note: This platform is not officially supported by ProcessMaker and has NOT been tested by ProcessMaker QA department.

Follow these instructions to install ProcessMaker 3.3.X on top of a LAMP (Linux, Apache, MySQL, PHP) stack in Ubuntu 18.04 LTS (Bionic Beaver).

ProcessMaker 3.3 is not compatible with PHP 7.2 in the Ubuntu 18.04 repository, so PHP 7.1 needs to be installed from a third-party repository. ProcessMaker 3.3 also has not been tested with MariaDB 10.1, so MySQL 5.6 needs to be downloaded from Oracle's website.

Before installing, it is recommended to first check the Installation Requirements. After installing, see Additional Server Configuration.

Step 1: Install MySQL

To get MySQL 5.6, go to https://dev.mysql.com/downloads/mysql/5.6.html#downloads and download the tar file for MySQL 5.6 in Ubuntu 14.04. Then decompress it.

If using the command line, it can be downloaded and unpacked in this manner:

wget https://cdn.mysql.com//Downloads/MySQL-5.6/mysql-server_5.6.42-1ubuntu14.04_amd64.deb-bundle.tar tar -xvf mysql-server_5.6.42-1ubuntu14.04_amd64.deb-bundle.tar

Then, install the mysql .deb packages which you want to install. To install all of them:

sudo dpkg -i mysql-client_* mysql-community-server_* mysql-server_* mysql-community-source_* libmysqlclient18_* libmysqlclient-dev_* libmysqld-dev_* mysql-community-client_* mysql-community-bench_* mysql-common_* mysql-community-test_* mysql-testsuite_*

There will be errors about missing dependencies. To resolve these dependencies and finish the installation, issue the command:

apt-get -f install

When MySQL is being installed, a dialog box will appear asking for a new root password for MySQL.

Enter a password and select the option OK. Then enter the same password a second time in the next screen to confirm it.

Then, Verify that MySQL is correctly configured as a service:

sudo systemctl status mysql

(Press q to quit.)

Then, configure MySQL to turn off MySQL STRICT mode, which is enabled by default in MySQL 5.6.6 and later. Also, make sure that ONLY_FULL_GROUP_BY mode is not enabled, which is the default in MySQL 5.7.5 and later.

First, login to MySQL and verify the current settings for sql_mode:

mysql -u root -p

Once inside MySQL, issue the following command:

mysql> SELECT @@SESSION.sql_mode, @@GLOBAL.sql_mode; +------------------------+------------------------+ | @@SESSION.sql_mode | @@GLOBAL.sql_mode | +------------------------+------------------------+ | NO_ENGINE_SUBSTITUTION | NO_ENGINE_SUBSTITUTION | +------------------------+------------------------+ 1 row in set (0,00 sec)

The sql_mode should not include NO_ENGINE_SUBSTITUTION, STRICT_ALL_TABLES, STRICT_TRANS_TABLES or ONLY_FULL_GROUP_BY settings. If any of those settings are included, then copy the current sql_mode settings, but exclude those four. Then, exit MySQL:

mysql> EXIT;

Then, edit the file /etc/mysql/conf.d/mysql.cnf to change the sql_mode:

sudo nano /etc/mysql/conf.d/mysql.cnf

Under the [mysqld] section, add the sql_mode settings which don't include the above four settings which aren't allowed. In this example, there are none, so set:

[mysqld] sql_mode=""

Then, exit nano by pressing CTL and x simultaneously and press y to the question asking if the changes should be saved.

Then, restart the mysql service for new configuration to take effect:

sudo systemctl restart mysql

Step 2: Install PHP and Apache

Add Ondřej Surý's PHP repository:

sudo add-apt-repository ppa:ondrej/php sudo apt update

Press ENTER at the question whether to continue adding the repository.

Then install Apache 2.4 and PHP 7.1 with the following command:

sudo apt install apache2 php7.1 php7.1-mbstring php7.1-mcrypt php7.1-mysql php7.1-xml php7.1-gd php7.1-ldap php7.1-curl php7.1-cli php7.1-soap

Install PhpMyAdmin

phpMyAdmin can be installed to easily view the MySQL databases used by ProcessMaker inside a web browser.

First, verify that the "universe" repository is in your /etc/apt/sources.list file. If not, edit the file:

sudo nano /etc/apt/sources.list

Add "universe" to the end of the list of repositories in a line which is similar to the following:

deb http://us.archive.ubuntu.com/ubuntu/ bionic universe

(Your URL and the list of repositories may be different, but make sure that it contains at least "bionic" and "universe".)

Then, update the list of available packages from the repositories:

sudo apt update

Then, install PhpMyAdmin:

sudo apt install phpmyadmin

If asked which web server PhpMyAdmin should use, press the space bar to select "apache2":

Select whether to configure the database with the dbconfig-common package. In most cases, it is easier to select Yes:

When asked for a password to create the MySQL databases, enter the MySQL root password:

Then, enter a password which can be used to access the PhpMyAdmin web application:

Reconfirm that password by entering it a second time.

Step 3: Configuring PHP Settings

The default configuration of PHP should be able to run ProcessMaker, however, check the following settings if PHP's configuration file php.ini has been modified.

Edit PHP 7.1's configuration file php.ini:

sudo nano /etc/php/7.1/apache2/php.ini

Search for the following lines and edit them using the following configurations:

file_uploads = On short_open_tag = On memory_limit = 512M error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT display_errors = Off post_max_size = 24M upload_max_filesize = 24M

It is also recommended to set the date.timezone to a your time zone, especially if using timer events in the Enterprise Edition. See this list of supported time zones.

date.timezone = America/New_York

Note: After installation, the same time zone should be set in the ProcessMaker interface by going to Admin > Settings > System and setting the Time Zone (or in the env.ini file).

After editing the php.ini file, save the changes in Nano by pressing CTL+X and pressing y when asked whether to save the changes.

Step 4: Download & Extract ProcessMaker

Go to ProcessMaker's SourceForge page and download a recent tarball of ProcessMaker, which should be named processmaker-X.X.X.X-community.tar.gz.

If downloading from the command line, the wget command can be used to obtain the ProcessMaker code: wget https://razaoinfo.dl.sourceforge.net/project/processmaker/ProcessMaker/3.3.0/processmaker-3.3.0-community.tar.gz

After the download has finished, decompress the tarball in the directory where ProcessMaker will be installed. ProcessMaker can be installed in any directory which is not publicly accessible to the internet (so do NOT install it in /var/www), but it is generally installed in /opt, since it is an optional program which doesn't come from the standard repositories:

tar -C /opt -xzvf processmaker-3.X.X-community.tar.gz

Verify that ProcessMaker was correctly decompressed:

ls /opt/processmaker

The processmaker directory should contain the following contents:

Set file permissions

Then, issue the following commands with sudo, so that ProcessMaker can access the necessary files when run by the Apache server:

sudo chown -R www-data:www-data /opt/processmaker

Step 5: MySQL Configuration

Set up a secure installation of MySQL, by removing the "test" database and the remote connections, with the following command:

sudo mysql_secure_installation

Follow the wizard to secure MySQL:

Here it is necessary to enter root password:

In the next part, it is possible to change the root password if wanted.

Then, remove anonymous users by choosing "Y":

In this part, the prompt will ask about disabling root login. Answer Y to disable remote access.

Then, it is possible to remove the default "Test" database:

Finally, reload privileges tables:

Once done, restart the "mysql" service.

sudo systemctl restart mysql

Set a user other than root

The MySQL "root" user should already have all the necessary privileges to setup the ProcessMaker databases. If planning on using a MySQL user other than "root" to set up the ProcessMaker databases, then follow the instructions below to grant a MySQL user superuser privileges to create and update databases.

Login to MySQL:

mysql -u root -p

Enter the root password for MySQL.

Once in MySQL, give the user which will be running ProcessMaker superuser privileges to create create and modify MySQL databases:

mysql> grant all on *.* to 'USER'@'localhost' identified by 'PASSWORD' with grant option;

Replace USER with the name of your MySQL user and PASSWORD with the password for that user. (If that user doesn't already exist, he/she will be automatically created with the above grant command. If you are running ProcessMaker on a different server than your MySQL server, then replace localhost with the domain name or IP address of the server where ProcessMaker is located.

Exit MySQL:

mysql> exit;

MySQL Configuration Issues

Setting the root Password

If MySQL doesn't have a root password, set one for better security:

sudo mysqladmin -u root password PASSWORD

If you have forgotten the root password, see these instructions to reset it.

Starting as a Service

When logging into MySQL, if the following error message appears:

ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (2)

Then, MySQL needs to be started as a service:

sudo systemctl start mysql

If MySQL was installed from Oracle's MySQL repository, it should automatically start as a service on bootup. If not, then use use update-rc.d to add it as a service:

sudo update-rc.d mysql defaults

Step 6: Configure Apache

Copy the sample ProcessMaker configuration file (which is named pmos.conf.example) to Apache's list of available sites:

sudo cp /opt/processmaker/pmos.conf.example /etc/apache2/sites-available/pmos.conf

Then edit the pmos.conf file to fit your environment:

sudo nano /etc/apache2/sites-available/pmos.conf In Apache 2.4, use the following VirtualHost configuration. In the pmos.conf file, replace your_ip_address and your_processmaker_domain with the IP address or domain name used by your ProcessMaker server. And replace /opt/processmaker with your installation directory:

#processmaker virtual host <VirtualHost your_ip_address > ServerName "your_processmaker_domain" DocumentRoot /opt/processmaker/workflow/public_html DirectoryIndex index.html index.php <Directory /opt/processmaker/workflow/public_html> Options Indexes FollowSymLinks MultiViews AddDefaultCharset UTF-8 AllowOverride All Require all granted ExpiresActive On <IfModule mod_rewrite.c> RewriteEngine On RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^.*/(.*)$ app.php [QSA,L,NC] </IfModule> #Deflate filter is optional. It reduces download size, but adds slightly more CPU processing: AddOutputFilterByType DEFLATE text/html </Directory> </VirtualHost>

Replace your_ip_address with the IP number or domain name of the server running ProcessMaker. If only planning on running and accessing ProcessMaker on your local machine, then use the IP address "127.0.0.1". If using ProcessMaker on a machine whose IP address might change (such as a machine whose IP address is assigned with DHCP), then use *, which represents any IP address. If not using the standard port 80, then it is necessary to also specify the port number.

If your DNS or /etc/hosts has a defined domain for ProcessMaker, then use that domain for your_processmaker_domain. Otherwise, use the same IP address for your_processmaker_domain as was used for your_ip_address. For more information, see the Apache Virtual Hosts Documentation.

Note 1: It is also possible to define the virtual host for ProcessMaker directly in the Apache configuration by inserting the above VirtualHost definition in the file /etc/apache2/apache2.conf.

Note 2: If using Apache's mod_proxy_fcgi and php-fpm, then add the following line to the virtualhost definition: SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1