Creating an OTOBO test system – Step-by-step guide

An OTOBO test system is an isolated environment for validating features, configurations, and updates without affecting production. If the environment should mirror production as closely as possible, also read the OTOBO staging system guide.

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 errors and bugs before they reach the production system

Prerequisites for the OTOBO test system

Before you begin creating an OTOBO test system, you should meet the following requirements:

• System resources: At least 2 CPUs, 4 GB RAM, and 20 GB of hard 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 need access to the database and the files of the production system.

Step 1: Prepare the environment

Docker-based installation (recommended)

For a quick and easy setup, we recommend the Docker installation. This allows for 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 would like to set up the OTOBO test system without Docker, install the required components (Apache, MariaDB, Perl modules) according to the OTOBO installation guide. This process requires more manual steps.

Step 2: Copy production system data (optional)

If you want to set up the test system based on the current production system, follow the steps below. 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 of 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 configurations for the database so that it points 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 persons 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.

Frequently asked questions

Why is an OTOBO test system essential for my organization?

An OTOBO test system is crucial for any organization using OTOBO because it provides a safe, isolated environment to validate new features, configurations, and updates without risking the stability or data integrity of your live production system. This allows administrators and developers to thoroughly test system updates, evaluate customizations, and identify and fix potential errors or bugs before they impact real users or customers. By proactively testing in a dedicated environment, you can ensure a smoother rollout of changes, minimize downtime, and maintain a high level of service quality for your OTOBO instance. It's a fundamental practice for robust system administration and continuous improvement.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide

What critical security and configuration considerations should I keep in mind when setting up an OTOBO test system, especially regarding email?

When setting up an OTOBO test system, security and configuration are paramount to prevent unintended interactions with your production environment. Most importantly, you must disable or redirect all outbound email notifications to ensure that test tickets or system messages never reach real customers. This can be done by adjusting email configurations within the test system. Additionally, if you copy production data, it is critical to change all sensitive information such as passwords and customer email addresses immediately after import. Access to the test system should also be restricted using firewalls or access controls, limiting it to authorized personnel only. These steps safeguard your production data and customer privacy while allowing for realistic testing.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide

How does an OTOBO test system differ from a staging environment?

While both OTOBO test systems and staging environments serve to validate changes outside of production, they have distinct primary purposes and characteristics. A staging environment typically aims to be a near-perfect replica of the production system, including hardware, software, and data, used for final pre-production testing and performance validation. Its goal is to simulate the live environment as closely as possible. In contrast, an OTOBO test system can be a lighter-weight environment, often used for broader experimentation, initial feature validation, trying out new configurations, or developing customizations. It doesn't always need to mirror production precisely, offering more flexibility for diverse testing scenarios. The main guide for staging systems provides more details on that specific setup.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide- OTOBO staging system guide

What are the recommended methods for preparing the environment for an OTOBO test system?

There are two primary methods for preparing the environment for an OTOBO test system. The Docker-based installation is highly recommended for its speed, ease of setup, and ability to create an isolated test environment. This involves installing Docker and Docker Compose, cloning the OTOBO Docker repository from GitHub, and configuring the .env file with a secure database password. This method simplifies dependency management and ensures portability. Alternatively, a manual installation is possible, requiring you to install components like Apache, MariaDB, and Perl modules according to the standard OTOBO installation guide. While offering more granular control, the manual approach involves more steps and requires a deeper understanding of the underlying infrastructure.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide- OTOBO Docker repository

Is it necessary to copy production data to my OTOBO test system, and how is it done safely?

Copying production data to your OTOBO test system is optional but highly recommended if you want to test configurations and data in a realistic scenario that mirrors your live environment. This process involves two main parts: backing up the production database using mysqldump and backing up critical file system directories, specifically /opt/otobo/Kernel and /opt/otobo/var/article, using rsync. These backups are then imported into your test system's database and file structure. It is absolutely crucial to change all sensitive data (e.g., passwords, email addresses) immediately after importing into the test environment and ensure the test system cannot accidentally interact with production customers. This step ensures data privacy and system integrity.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide

What are the minimum system requirements for an OTOBO test system?

To set up an OTOBO test system, you should meet certain minimum system requirements, although it can often run on lower specifications than a production system due to its non-production intent. The recommended prerequisites include at least 2 CPUs, 4 GB of RAM, and 20 GB of hard disk space. For the operating system, Ubuntu 20.04 or Debian 10 are recommended, providing a stable base. It's also important to note that a Docker setup is a viable option for the operating environment, offering an isolated and efficient way to deploy the test system. These specifications ensure that the test system has sufficient resources to perform various tests and configurations effectively.Quellen / Sources:- Creating an OTOBO test system – Step-by-step guide