Creating an OTOBO Test System – A Step-by-Step Guide

An OTOBO test system is an excellent way to safely test new features, configurations, and updates without affecting the production system. In this article, we will show you how to create and set up a separate OTOBO test system.

Why an OTOBO Test System?

An OTOBO test system allows you to:

• Safely try out new features and configurations
• Test system updates before live implementation
• Evaluate customizations and scripting changes
• Identify and fix sources of error and bugs before they reach the production system

Prerequisites for the OTOBO Test System

Before you start creating an OTOBO test system, you should meet the following prerequisites:

• System Resources: At least 2 CPUs, 4 GB RAM, and 20 GB of disk space. The test system can run on lower specifications as it is not intended for production use.
• Operating System: Ubuntu 20.04 or Debian 10 is recommended. A Docker setup is also possible.
• Access to Production System Data (optional): If you want to test a copy of the current OTOBO installation, you will need access to the production system's database and files.

Step 1: Prepare the Environment

Docker-based Installation (Recommended)

For a quick and easy setup, we recommend the Docker installation. This provides an isolated test environment.

1. Install Docker and Docker Compose:

   sudo apt update
   sudo apt install docker.io docker-compose

2. Clone the OTOBO Docker repository:

   cd /opt
   git clone https://github.com/RotherOSS/otobo-docker.git --branch rel-11_0 --single-branch

3. Copy the .env file for the test system:

   cd /opt/otobo-docker
   cp -p .docker_compose_env_http .env

4. Configure the password for the database admin user: Open the .env file and set a secure password:

   OTOBO_DB_ROOT_PASSWORD=<your_secret_password>

Alternative: Manual Installation

If you prefer to set up the OTOBO test system without Docker, install the required components (Apache, MariaDB, Perl modules) according to the OTOBO installation guide. Note that this process is more complex and requires more manual steps.

Step 2: Copy Data from the Production System (Optional)

If you want to set up the test system based on the current production system, follow these steps. This is optional but useful if you want to test configurations and data in a realistic scenario.

1. Back up the production database:

   mysqldump -u root -p otobo > /path/to/backup/otobo_backup.sql

2. Back up the file system: Copy the Kernel directory and the var/article directory from the production system:

   rsync -avz /opt/otobo/Kernel /path/to/backup/Kernel
   rsync -avz /opt/otobo/var/article /path/to/backup/article

3. Import the backup into the test system:

   • Database: Copy the backup to the test system and import it:

     mysql -u root -p otobo_test < /path/to/backup/otobo_backup.sql

   • File System: Copy the backed-up Kernel and article directories to the test system.

Note: After importing into the test environment, change all sensitive data (e.g., passwords, email addresses) and ensure that the test system does not accidentally come into contact with production customers.

Step 3: Configure the OTOBO Test System

1. Adjust the database connection: Open the Kernel/Config.pm file in the OTOBO test system and change the database configurations to point to the test database:

   $Self->{'Database'}{'Type'} = 'mysql';
   $Self->{'Database'}{'Host'} = 'localhost';
   $Self->{'Database'}{'Name'} = 'otobo_test';
   $Self->{'Database'}{'User'} = 'otobo';
   $Self->{'Database'}{'Password'} = '<your_test_database_password>';

2. Verify the test environment: Restart the OTOBO daemon and check if the test system is running correctly:

   docker-compose exec web bash
   bin/otobo.Daemon.pl start

Step 4: Secure the Test System

• Restrict access: Limit access to the test system using firewalls or access controls to prevent unauthorized individuals from accessing it.
• Disable email notifications: Ensure that the test system does not send any emails. Adjust the email configurations accordingly.

Step 5: Use the Test System and Perform Tests

The OTOBO test system is now ready. You can:

• Test new features and configurations
• Try out scripts, integrations, and customizations
• Evaluate updates and migration paths

Summary

Creating an OTOBO test system is an important step to safely try out new features, configurations, and updates. With this guide, you can create an OTOBO test system to optimize your processes and identify potential problems early on. Remember to comply with data protection regulations, especially when copying data from your production system.

Need help setting up your OTOBO test system? Contact us for more information!