Transact

  1. Home
  2. Transact
  3. Install and Upgrade
  4. Additional Resources
  5. Linux
  6. Install and Migrate to MariaDB for Linux

Install and Migrate to MariaDB for Linux

Introduction

This document provides information on important changes related to MariaDB and MySQL on Linux. The following changes affect Ephesoft Transact 2019.2 or above:

  • The Ephesoft Transact installer no longer installs any database management systems (DBMS).
  • Ephesoft Transact no longer supports MySQL databases.

Refer to the Platform Configurations and Third-Party Integrations article for your version of Ephesoft Transact to find more information on supported database versions.

Prerequisites

There are no prerequisites for this document.

Installing Ephesoft Transact

Follow these instructions if you are installing Ephesoft Transact 2019.2 or above for the first time.

Check for MariaDB

  1. Check your system for an existing instance of MariaDB before installing Ephesoft Transact, as some Linux operating systems include MariaDB.
  • If you do not have an existing instance of MariaDB, proceed to Install MariaDB.
  • If you have an existing instance of MariaDB that is supported for Ephesoft Transact 2019.2 or above, you can return to the Linux install guide for your version.
  • If you have an existing instance of MariaDB that is not supported for Ephesoft Transact 2019.2 or above, you will need to uninstall your instance of MariaDB and install a supported version.

Important: This will remove all data from your database. It is recommended to take a backup of your database by running the following command:

mysqldump --all-databases --single-transaction --quick --lock-tables=false > full-backup.sql -uroot -p<password>

   a.  Refer to your operating system below and run the listed command.

      • Ubuntu:
        sudo apt-get remove mariadb-server
      • CentOS or RHEL:
        sudo yum remove mariadb mariadb-server

   b.  Proceed to Install MariaDB.

Upgrading Ephesoft Transact

Follow these instructions if you are upgrading to Ephesoft Transact 2019.2 or above. This section provides instructions on how to upgrade or migrate your database in the following cases:

  • Existing MariaDB
  • Existing MySQL

Existing MariaDB

If you have an existing instance of MariaDB, ensure that your instance of MariaDB is a supported version before upgrading Ephesoft Transact. Refer to Install and Upgrade and reference the Platform Configurations and Third-Party Integrations article specific to your version for more information.

  • If your instance of MariaDB is supported for upgrade to Ephesoft Transact 2019.2 or above, you can return to the Linux upgrade guide for your version.
  • If your instance of MariaDB is not supported for upgrade to Ephesoft Transact 2019.2 or above, proceed to Upgrade MariaDB.

Existing MySQL

Follow these steps if you are currently using MySQL with Ephesoft Transact.

  1. Back up the ephesoft, report, and report_archive databases from the pre-existing MySQL database.

   a.  Run the following command in the MariaDB installation bin folder, located in <Transact Installation Folder>/Dependencies/mariadb/bin/.

mysqldump -u<root username> -p<root user password> -h<server hostname> -P<database port number> <Database name> --single-transaction --routines --quick --lock-tables=false > <Folder location>.sql

Note: Code listed in angled brackets are placeholders. Replace the placeholders with the relevant information. For <Folder location> include the full folder path where the backup file will be created.

   b.  Run the mysqldump command for the ephesoft, report, and report-archive databases. Below are sample commands for each:

mysqldump -uroot -p ephesoft –-single-transaction –-routines -–quick -–locktables=false > /opt/database_backup/ephesoft.sql
mysqldump -uroot -p report –-single-transaction --routines --quick –-lock-tables=false > /opt/database_backup/report.sql
mysqldump -uroot -p report --single-transaction --routines --quick-lock-tables=false > /opt/database_backup/report_archive.sql
  1. Stop and disable the service for the MySQL database to prevent it from running.
  2. Install a supported version of MariaDB. You can install MariaDB on the same server where Ephesoft Transact will be installed or choose a dedicated database server. Continue to Install MariaDB to proceed.

Install MariaDB

This section provides information on how to install MariaDB on different Linux distributions: Ubuntu, CentOS, and Red Hat Enterprise Linux (RHEL). Refer to Install and Upgrade and reference the Platform Configurations and Third-Party Integrations article for your version of Ephesoft Transact to find more information on supported operating systems.

Note: Ephesoft Transact 2020.1 only supports RHEL 7.5 and 7.6

Follow the instructions for your specific Linux distribution, and proceed with the configuration.

RHEL or CentOS

  1. Run the following command to add a MariaDB YUM repository to your server:
vi /etc/yum.repos.d/MariaDB.repo
  1. Add the following lines of code to your respective Linux distribution version as shown.

Important: CentOS is not supported for Ephesoft Transact 2020.1 or above.

On RHEL 7

cat <<EOF | sudo tee /etc/yum.repos.d/MariaDB.repo
[mariadb]
name = MariaDB
baseurl = http://yum.mariadb.org/10.3/rhel7-amd64
gpgkey=http://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1
EOF

On CentOS 7

cat <<EOF | sudo tee /etc/yum.repos.d/MariaDB.repo
[mariadb]
name = MariaDB
baseurl = http://yum.mariadb.org/10.3/centos7-amd64
gpgkey=http://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1
EOF

A screenshot of a cell phone Description automatically generated

Figure 1: On CentOS 7

  1. Run the following command to manually create the cache so that future yum queries will be quicker:
yum makecache fast

A screenshot of a cell phone Description automatically generated

Figure 2: Make Cache Fast

  1. Once the MariaDB YUM repository has been added, you can install MariaDB with the following command:
yum install MariaDB-server MariaDB-client
  1. Run the following commands to start the MariaDB service and enable it to start automatically in the future:
systemctl start mariadb
systemctl enable mariadb

Figure 3: Start MariaDB Service

  1. Secure MariaDB by running the following command.
mysql_secure_installation

Figure 4: Secure Installation

This will prompt you to set the root password, disable remote root login, remove the test database and anonymous users, and reload privileges.

Figure 5: Secure MariaDB

  1. Verify that a supported version of MariaDB was installed with one of the following:
    • Run the following command:
mysql -v

This will return the server version as a response.

Figure 6: Verify Version

    • Login to the MariaDB command shell by running following command and entering the root password:
mysql -u root -p

This will log in as the root user and return the server version as a response.

Figure 7: Root Login

  1. Proceed to Create a New Database to continue the installation.

Ubuntu

Note: Ubuntu is not supported for Ephesoft Transact 2020.1 or above. You must have the software-properties-common library installed prior installing MariaDB on Ubuntu. If the library is not installed, run the following command:

sudo apt-get install software-properties-common.
  1. Run the following command to install GNU Privacy Guard (GPG) to Ubuntu:
sudo apt install gnupg.
  1. Run the following command to add the MariaDB GPG key:
sudo apt-key adv --recv-keys --keyserver hkp://keyserver.ubuntu.com:800xF1656F24C74CD1D8
  1. Run the following command to add an APT repository to your server:
sudo add-apt-repository ‘deb [arch=amd64,arm64,i386,ppc64el] http://sfo1.mirrors.digitalocean.com/mariadb/repo/10.3/ubuntu/ xenial main’
  1. Run the following commands to install a supported version of MariaDB:
sudo apt-get update
sudo apt-get install mariadb-server mariadb-client
  1. When prompted, create a MariaDB root password. Keep the password in a safe location for future use.

https://computingforgeeks.com/wp-content/uploads/2018/06/mariadb-ubuntu-set-password-01.png

Figure 8: Create Password

  1. Re-enter the password and select <Ok> to confirm.

https://computingforgeeks.com/wp-content/uploads/2018/06/mariadb-ubuntu-set-password-02.png

Figure 9: Confirm Password

  1. Verify that a supported version of MariaDB was installed with one of the following:
    • Run the following command:
select version();

This will return the server version as a response.

    • Login to the MariaDB command shell by running following command and entering the root password:
mysql -u root -p.

This will log in as the root user and return the server version as a response.

  1. Proceed to Create a New Database to continue the installation.

Create a New Database

Once you have installed MariaDB, you will need to create the following three databases for Ephesoft Transact: ephesoft, report, and report_archive.

  1. Run the following commands on any MariaDB client tool, replacing the <username> with your username:
CREATE DATABASE IF NOT EXISTS ephesoft ;
CREATE DATABASE IF NOT EXISTS report ;
CREATE DATABASE IF NOT EXISTS report_archive ;
GRANT ALL PRIVILEGES ON ephesoft.* TO '<username>'@'%';
GRANT ALL PRIVILEGES ON report.* TO '<username>'@'%';
GRANT ALL PRIVILEGES ON report_archive.* TO '<username>'@'%';
GRANT ALL PRIVILEGES ON ephesoft.* TO '<username>'@'localhost';
GRANT ALL PRIVILEGES ON report.* TO '<username>'@'localhost';
GRANT ALL PRIVILEGES ON report_archive.* TO '<username>'@'localhost';
FLUSH PRIVILEGES;

Note: When the IF NOT EXISTS clause is used, MariaDB will return a warning instead of an error if the specified database already exists.

  1. Update the database details in all three resource tags in the <Ephesoft Installation Folder>\JavaAppServer\conf\server.xml file. Refer to the image below for an example:

Figure 10: Update Resource Tags

  1. You have successfully installed MariaDB. Continue to Restore MySQL Backup if you previously performed a backup of your MySQL database. Otherwise, return to the Linux guide for your version of Ephesoft Transact to complete your installation or upgrade.

Restore MySQL Backup

Perform these steps if you are migrating your database from MySQL. This section outlines how to restore your ephesoft, report, and report_archive databases that you backed up in the section titled Pre-existing MySQL.

Important: Ensure that the original MySQL database is stopped and disabled, and the new MariaDB database is running.

  1. Use the following command to restore each database, replacing the placeholders in the angled brackets (< >) with the relevant details:
mysql -u<root username> -p<root user password> -P<database server port> <Database name> < <Folder location>\database_backup.sql

Below is a sample to restore each database:

mysql -uroot -ppassword -P3306 ephesoft < ephesoft.sql\database_backup.sql

mysql -uroot -ppassword -P3306 report < report.sql\database_backup.sql

mysql -uroot -ppassword -P3306 report_archive < report_archive.sql\database_backup.sql
  1. You have successfully restored the ephesoft, report, and report_archive databases in MariaDB. Return to the Linux guide for your version of Ephesoft Transact to complete your upgrade.

Upgrade MariaDB

This section provides instructions on how to upgrade your current MariaDB instance to a supported version. Refer to Install and Upgrade and reference the Platform Configurations and Third-Party Integrations article for your version of Ephesoft Transact to find more information on supported database versions.

Note: Ephesoft Transact 2020.1 currently supports MariaDB 10.3.x (10.3.18 tested).

  1. Download a supported version of MariaDB from the MariaDB Foundation.
  2. Run the following commands to stop the ephesoft and mysql services:
service ephesoft stop
service mysql stop
  1. Rename the existing MariaDB folder:
mv /opt/mariadb /opt/mariadb-backup
  1. Move the .tar file to the /opt folder:
mv mariadb-xx.x.xx-linux-x86_64.tar.gz /opt/

Note: xx.x.xx has been added as a placeholder. Replace with your current version of MariaDB.

  1. Extract the .tar file:
tar -xvzf mariadb-xx.x.xx-linux-x86_64.tar.gz

Note: xx.x.xx has been added as a placeholder. Replace with your current version of MariaDB.

  1. Rename the mariadb-xx.x.xx-linux-x86_64 folder to mariadb:
mv mariadb-xx.x.xx-linux-86_64 mariadb

Note: xx.x.xx has been added as a placeholder. Replace with your current version of MariaDB

  1. Rename the my.cnf file to my.cnf.backup:
mv /etc/my.cnf /etc/my.cnf.backup
  1. Remove the mysql service:
rm -rf /etc/init.d/mysqld
  1. Open the mariadb folder:
cd /opt/mariadb
  1. Run the mysql_install_db script:
./scripts/mysql_install_db --basedir=/opt/mariadb --datadir=/opt/mariadb/data
  1. Restore the my.cnf file:
cp /opt/mariadb-backup/support-files/my.cnf /etc/
  1. Restore the service:
cp /opt/mariadb-backup/support-files/mysqld /etc/init.d/
  1. Remove the old links:
rm -rf /usr/bin/mysql
rm -rf/usr/bin/mysqldump
rm -rf/usr/bin/mysqladmin
  1. Create new links:
ln -s /opt/mariadb/bin/mysql /usr/bin/mysql
ln -s /opt/mariadb/bin/mysqldump /usr/bin/mysqldump
ln -s /opt/mariadb/bin/mysqladmin /usr/bin/mysqladmin
  1. Run the following command to add MariaDB to the list of services that will start after the system reboots. This command differs based on your Linux distribution:
    • Ubuntu:
update-rc.d mysqld defaults
    • CentOS or RHEL:
chkconfig --add mysqld
  1. Restore the data backups:
mv /opt/mariadb/data /opt/mariadb/data-backup
cp -r /opt/mariadb-backup/data /opt/mariadb/
rm -rf /var/lock/subsys/mysql
  1. Allow permissions within the my.cnf file:
chmod -R 0777 /etc/my.cnf
  1. Open the my.cnf file and insert the following comments:
#innodb_large_prefix=on
#innodb_file_format=barracuda
#innodb_file_per_table=true
  1. Adjust the permissions within the my.cnf file:
chmod -R 0755 /etc/my.cnf
  1. Start the database service:
service mysqld start
  1. Run the upgrade:
./bin/mysql_upgrade -uroot –p<password>

The upgrade process is complete. Return to the Linux guide for your version of Ephesoft Transact to complete your installation or upgrade.

Conclusion

You have successfully configured MariaDB for Ephesoft Transact.

Was this article helpful to you? Yes No