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 Debian 9 (Stretch).
ProcessMaker 3.3 is compatible with PHP 7.0 and Apache 2.4 found in the official Debian 9 repository, but it is recommended to install MySQL 5.6 from Oracle's repository for Debian. Note that MariaDB may also be used with ProcessMaker 3.3, but it not been tested by the QA team.
Step 1: Install MySQL
First login as root or use
sudo -i to gain root access:
(All the rest of the commands in this document should be issued as the root user.)
Then, download and install the package to use Oracle's repository for MySQL.
When installing the MySQL repository, a configuration screen will appear in the terminal, asking packages should be included. Use the arrow keys to select the option "MySQL Server and Cluster" and press ENTER.
Then, in the next configuration screen that appears, select "mysql-5.6" and then press TAB to select OK and press ENTER.
When returning to the first screen, select "OK" and press ENTER to finish configuring the repository.
Then, update the list of available packages:
Then, install PHP 5.6:
When MySQL is being installed, a dialog box will appear asking for a new root password for MySQL.
Enter a password and press TAB to select 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:
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:
Once inside MySQL, issue the following command:
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:
Then, edit the file /etc/mysql/conf.d/mysql.cnf to change 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]section doesn't exist, then it needs to be created. If
sql_modeis placed under the
[mysql]section then it will cause an error.
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:
Step 2: Install PHP and Apache
As the root user, install Apache 2.4 and PHP 7.0 from the Debian repository with the following command in the terminal:
Install PhpMyAdmin with the following command:
When asked which web server PhpMyAdmin should use, press the space bar to select "apache2" and then press TAB to select OK and press ENTER to continue:
Then, select whether to configure the database with the dbconfig-common package. In most cases, it is easier to select Yes:
Then, enter a password which can be used to access the PhpMyAdmin web application:
Reconfirm that password by entering it a second time.
When asked for a password to access the MySQL databases, enter the MySQL root password:
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.0's configuration file php.ini:
Search for the following lines and edit them using the following configurations:
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-3.X.X-community.tar.gz.If downloading from the command line, the wget command can be used to obtain the ProcessMaker code:
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:
Verify that ProcessMaker was correctly decompressed:
The processmaker directory should contain the following contents:
Set file permissions
Then, change the ownership of the ProcessMaker files, so that they can be accessed by the Apache server:
Step 5: MySQL Configuration
Set up a secure installation of MySQL, by removing the "test" database and the remote connections, with the following command:
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.
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:
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:
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.
MySQL Configuration Issues
Setting the root Password
If MySQL doesn't have a root password, set one for better security:
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:
Then, MySQL needs to be started as a service:
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:
Step 6: Configure Apache
Copy the sample ProcessMaker configuration file (which is named pmos.conf.example) to Apache's list of available sites:
Then edit the pmos.conf file to fit your environment:
your_processmaker_domainwith the IP address or domain name used by your ProcessMaker server. And replace /opt/processmaker with your installation directory:
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:
ProcessMaker is installed in the /opt/processmaker directory and is running on a server at the address 192.168.1.100:
ProcessMaker is installed in the /user/fred directory on your local machine at port 8080 with an dynamic IP assigned by DHCP:
ProcessMaker is installed in the /opt/pm3.3 directory at the IP address 126.96.36.199 and the domains
www.example.com and any variant of
*.example.com need to be defined in the server's DNS or /etc/hosts file for this example to work correctly.
Then save and write the pmos.conf.
Enable site and modules
After editing the pmos.conf file, enable the ProcessMaker web site, as the "root" user:
To activate the new configuration, reload the server.
ProcessMaker needs to use the following modules in the Apache 2 web server:
To check whether these modules are enabled, run the following command:
If you don't see them in the list, enabled them with the a2enmod command:
After adding the web site pmos.conf and enabling modules, it is necessary to restart the Apache web server:
Then, verify that Apache is correctly configured as a service and is functioning:
Apache Possible Configuration Issues
If a similar warning message appears when restarting Apache:
Then, the ServerName needs to be set for Apache. Edit the Apache configuration file:
Add the line:
For instance, if running ProcessMaker from the local machine, then:
If running ProcessMaker off a port other than the default port 80, then add the following line to the file /etc/apache2/ports.conf:
For instance, if running ProcessMaker from the local machine at port 8080:
Note: If Apache is using the default port 80, then configure other programs to not use port 80. Check whether a program is currently listening on port 80 with the command:
To configure Skype to stop listening on port 80, press CTRL+O or go to Tools > Options. Under the Advanced section of the "Options" dialog box, go to the "Connection" section and enter an alternative port for Use port [ ] for incoming connections.
Disable the default Apache site
Then, disable the default site:
After the web page is reloaded, it shouldn't display the default site.
No VirtualHosts Warning
If you see the following message when reloading or restarting Apache:
Then, comment out or delete the following line in the file /etc/apache2/ports.conf:
Step 7: Setting up ProcessMaker
Open a web browser and enter the IP address (and port number if not using the default port 80) where ProcessMaker is installed. For instance, if ProcessMaker is installed at the address 192.168.10.100, then go to: http://192.168.10.100
If using ProcessMaker which is installed locally on port 8080, go to: http://127.0.0.1:8080
Then follow the steps in the Installation Wizard in the web browser to complete the installation of ProcessMaker.
Step 8: Additional Configuration
Additional aspects of ProcessMaker may need to be configured. See Additional Server Configuration and the Administration section of the wiki. Most installations of ProcessMaker need to configure the following:
Setting the Time Zone
The default time zone for the ProcessMaker server can be set by logging into ProcessMaker with the "admin" user and going to Admin > Settings > System and setting the Time Zone. Another way to set the time zone is edit the env.ini configuration file.
Execution of cron.php
Configuring the mycrypt.ini
In case of having errors with the mycrypt extension, even if it was enabled, follow the steps below to fix the problem:
- Change the path of the mycrypt.so file location. Use the command line and write the locate command in order to find the path.
- Look for the mycrypt.ini file and open it.
- Copy the path of the mycrypt.so file in the mycrypt.ini file.
- Restart apache.
Errors during Installation
If an error occurs during the installation, check the installation log file:
Depending on the errors found in the installation log file, check the following files:
The Apache configuration file:
The ProcessMaker web site configuration file for Apache:
The PHP configuration file:
The MySQL configuration file:
The ProcessMaker configuration file where components are installed:
The ProcessMaker configuration file for database connections:
The ProcessMaker redirection to login screen:
If the following error appears at the login screen:
This error indicates that the installer was unable to access the MySQL databases to install the translations. Make sure that the MySQL port (which is 3306 by default) isn't blocked by a firewall and MySQL is configured to accept connections from the server running ProcessMaker.
If having other issues, please ask for help on our ProcessMaker forum.