TestOps logo
Try TestOps

Install Allure TestOps via DEB packages

This section describes how to install Allure TestOps 5.x on Ubuntu using DEB packages.

For reference, we kept the outdated installation manual for version 4.

Depending on the operating system's settings, you may encounter issues when pasting multi-line commands from this page into the terminal. To fix the behavior, we recommend running this command before you begin:

bind 'set enable-bracketed-paste on'

Migration from version 4

Allure TestOps version 5 cannot be deployed above the version 4. The upgrade process requires the data migration and switching to the new configuration.

The upgrade is possible only from the release 4.26.5. Using older releases for the upgrade process will brick the system and will lead to the data loss.

The upgrade to version 5 requires the following steps:

  1. Create the new testops.conf file for the updated DEB package based on your current configuration.
  2. Stop the existing instance.
  3. Merge the information from the UAA service database to the report service database.
  4. Start the deployment using the DEB package.

For more detailed information on upgrading your version of Allure TestOps to 5.x, follow the migration guide.

Preparation steps

  1. Make sure you run Ubuntu 20.04 LTS, 22.04 LTS or 24.04 LTS.

    Note that Qameta does not officially support Allure TestOps on non-LTS versions.

    To check the version of your operating system, run this in terminal:

    lsb_release -a

    Do not install Allure TestOps on a machine that is used for other purposes. Allure TestOps demands a lot of resources, so sharing resources with other software can cause serious performance issues.

  2. Deploy additional services:

    Note that it is recommended to run PostgreSQL and S3-compatible storage on separate machines. See Storage requirements for more details.

  3. Get a license for Allure TestOps.

    To receive the license key, contact us at [email protected] for a commercial license. Please indicate that you are planning to install Allure TestOps via DEB packages.

    When you receive the license key, you will also get a username and a password for accessing Qameta's DEB repository.

  4. Get details for configuring authentication.

    The required details depend on which approach to user authentication you choose. There are two possible approaches.

    • Standard password-based authentication, implemented by Allure TestOps itself.

      This option uses an SMTP server to send invitations to new users and does not require additional services.

    • Authentication via an external identity provider.

      The details required for this may vary depending on what type of identity provider you use. Usually, you will need to specify an external URL and a secret token generated by the identity provider.

    See Configuration → Authentication for more details.

Installing dependencies

Amazon Corretto

Amazon Corretto version 21 is used as the JDK implementation for running Allure TestOps. To install it, run the following commands in a terminal:

wget -q -O- https://apt.corretto.aws/corretto.key | sudo gpg --dearmor --output /usr/share/keyrings/corretto.gpg
echo "deb [signed-by=/usr/share/keyrings/corretto.gpg] https://apt.corretto.aws stable main" | sudo tee /etc/apt/sources.list.d/corretto.list
sudo apt update
sudo apt install -y java-21-amazon-corretto-jdk

For more details, see the installation guide on the Amazon website.

PostgreSQL

While not recommended for high-load use cases, it is possible to run PostgreSQL on the same machine you will be running Allure TestOps on. To install it, run the following commands in a terminal:

wget -q -O- https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo gpg --dearmor --output /usr/share/keyrings/pgdg.gpg
echo "deb [signed-by=/usr/share/keyrings/pgdg.gpg] http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
sudo apt update
sudo apt install -y postgresql-15

For more details, see the installation guide on the PostgreSQL website.

Wherever the PostgreSQL server is deployed, make sure to log into that server and prepare the database for Allure TestOps.

RabbitMQ

To install RabbitMQ, run the following commands in the terminal:

wget -q -O- https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/setup.deb.sh | sudo bash
sudo apt install -y socat logrotate erlang
wget https://github.com/rabbitmq/rabbitmq-server/releases/download/v3.13.2/rabbitmq-server_3.13.2-1_all.deb -O rabbitmq-server.deb
sudo dpkg -i rabbitmq-server.deb
sudo systemctl enable rabbitmq-server
sudo systemctl start rabbitmq-server

For more details, see the installation guide on the RabbitMQ website.

MinIO

MinIO can be used as the S3-compatible storage service for Allure TestOps.

To install MinIO, follow one of the official installation guides on the MinIO website:

Redis

To install Redis, run the following commands in the terminal:

wget -q -O- https://packages.redis.io/gpg | sudo gpg --dearmor --output /usr/share/keyrings/redis-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
sudo apt update
sudo apt install -y redis

For more details, see the installation guide on the Redis website.

Installing Allure TestOps

Allure TestOps packages are distributed via a repository that requires authentication. If you have a trial or commercial license for Allure TestOps, you should have received the username and password in the same email where you got the license key. If you cannot find it, contact us at [email protected].

Once you have got the login and password, do the following.

  1. Specify the credentials for accessing the Qameta repository.

    Before executing the command, replace USERNAME and PASSWORD with the credentials provided to you by the Qameta sales team.

    echo "machine dl.qameta.io login USERNAME password PASSWORD" | sudo tee /etc/apt/auth.conf.d/qameta.conf

  2. Add the Qameta repository to your system.

    Note that you must paste this command as a whole, without running its lines separately.

    cat <<EOF | sudo tee /etc/apt/sources.list.d/qameta.list
deb [trusted=yes] https://dl.qameta.io/artifactory/debian stable main
deb [trusted=yes] https://dl.qameta.io/artifactory/debian focal main
deb [trusted=yes] https://dl.qameta.io/artifactory/debian focal-pgdg main
deb [trusted=yes] https://dl.qameta.io/artifactory/deb-local stable main
EOF

  3. Refresh the index of available packages.

    sudo apt update

  4. Select the version of Allure TestOps to install.

    Note that you must paste this command as a whole, without running its lines separately. Before executing the command, replace 5.7.0 with the version you want to use.

    Check out the Release notes section for the list of available versions. In general, it is recommended to use the latest release.

    cat <<EOF | sudo tee /etc/apt/preferences.d/qameta
Package: testops
Pin: version 5.7.0
Pin-Priority: 1000
EOF

  5. Install the Allure TestOps package.

    sudo apt install -y testops

  6. If you are using a firewall, make sure that incoming traffic to the TCP port 8080 is allowed.

    Here's how to do it if you are using ufw:

    sudo ufw allow 8080/tcp

Editing the configuration file

The configuration parameters are defined in the /opt/testops/conf/testops.conf configuration file.

To change the parameters, open the file in a text editor, modify the values you need and save it. After that, restart Allure TestOps to apply the changes.

You need to use superuser privileges to modify the configuration file. One way to edit it with such privileges is to use the sudo nano command in a terminal:

sudo nano /opt/testops/conf/testops.conf

For the most typical setup, just do the following:

  1. Set TestOps URL.
  2. Set encryption key for sensitive data.
  3. Set first admin email.
  4. Configure authentication.
  5. Configure storage services.

Set TestOps URL

In the ALLURE_ENDPOINT parameter, specify the URL which should be used to access the Allure TestOps web interface.

ALLURE_ENDPOINT=https://testops.example.com/

To make Allure TestOps available via HTTPS, you need to configure a reverse proxy. See Network configuration for more details.

If you plan to integrate Allure TestOps with Jira, you need to use HTTPS and enable secure cookies, otherwise the integration will not work correctly. See Integration with Jira Data Center and Integration with Jira Software Cloud for more details.

ALLURE_SECURE=true

Set encryption key for sensitive data

As a security measure, Allure TestOps encrypts the sensitive values in its database using AES256 algorithm. This way, if a malicious actor gets access to the PostgreSQL database but not to the configuration file, this will not compromise the other services' credentials used by the deployment.

AES256 requires usage of an encryption key. To set the encryption key, update the value of the ALLURE_CRYPTO_PASSWORD parameter and keep it in a safe place.

Note that if the value is lost or changed after the initial deployment, all previously configured integrations will stop working. In such a case, you will need to go to each projects' settings and re-enter valid credentials.

ALLURE_CRYPTO_PASSWORD=ogheRiy7ooCh6Oocei6OdaD1iequooNa

Set first admin email

Starting from the version 5.4.0, valid SMTP credentials are required in any configuration. Allure TestOps will use them for sending an invitation email to the administrator, regardless of the main authentication method. The administrator's email address must be specified in the ALLURE_MAIL_ROOT parameter.

Below is an example of configuration parameters for a Gmail account. Note that Google requires to generate dedicated app passwords for SMTP. Other mail services may have similar requirements.

SPRING_MAIL_HOST=smtp.gmail.com
SPRING_MAIL_PORT=465
[email protected]
SPRING_MAIL_PASSWORD=Ohku6Zo9gee5aen0
[email protected]
SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_REQUIRED=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST=smtp.gmail.com

# ...

[email protected]

Configure authentication

A necessary step when deploying Allure TestOps is to configure how users (other than the very first administrator) will be registered and logged in. See Configuration → Authentication for more details.

Below are some configuration examples for various identity providers.

No additional configuration is required. This authentication (system) requires SMTP to be enabled.

#Example of using LDAP
ALLURE_LOGIN_PRIMARY=ldap
ALLURE_LOGIN_LDAP_ENABLED='true'
ALLURE_LOGIN_LDAP_REFERRAL=follow
ALLURE_LOGIN_LDAP_URL=ldap://ldap.url.here:port
# ALLURE_LOGIN_LDAP_USERDNPATTERNS= do not use with ALLURE_LOGIN_LDAP_USERSEARCHFILTER
ALLURE_LOGIN_LDAP_USERSEARCHBASE="ou=People,dc=space"
ALLURE_LOGIN_LDAP_USERSEARCHFILTER="uid={0}"
ALLURE_LOGIN_LDAP_DEFAULTROLE=${LDAP_DEFAULT_ROLE}
ALLURE_LOGIN_LDAP_UIDATTRIBUTE=uid
ALLURE_LOGIN_LDAP_SYNCROLES='true'
# these are to be enabled if ALLURE_LOGIN_LDAP_SYNCROLES='true'
ALLURE_LOGIN_LDAP_GROUPSEARCHBASE="ou=group,dc=space"
ALLURE_LOGIN_LDAP_GROUPSEARCHFILTER="memberUid={1}"
ALLURE_LOGIN_LDAP_GROUPROLEATTRIBUTE=cn

ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEUSERGROUPS=group_with_ato_users,every_user_is_user
ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEADMINGROUPS=group_with_ato_admins,every_user_is_admin
# service account data to log-in to LDAP
ALLURE_LOGIN_LDAP_USERDN="cn=admin,dc=space"
ALLURE_LOGIN_LDAP_PASSWORD='ServiceAccountPasswordHere'
# additional parameters, can be disabled by default
#ALLURE_LOGIN_LDAP_LOWERCASEUSERNAMES=true
#ALLURE_LOGIN_LDAP_PASSWORDATTRIBUTE=userPassword

To use an OpenID IdP, you need to add values to the following strings according to the settings of Allure TestOps and the identity provider.

# OpenId settings
# The text ID for the SSO provider. Will be used in URLs and displayed on the login buttons.
# Don't use whitespaces and special characters
# You can use array of different providers using different oauth2:
# SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_<PROVIDER_NAME>_... + SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_<PROVIDER_NAME>_...
 ########################################################################################
ALLURE_LOGIN_PRIMARY=openid
ALLURE_LOGIN_OPENID_DEFAULTROLE=ROLE_GUEST
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTNAME=openid
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTID=<as defined in your IdP>
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTSECRET=<as defined in your IdP>
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_REDIRECTURI=http://<your-testops-domain>/login/oauth2/code/openid
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_SCOPE=openid,email,profile
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_AUTHORIZATIONGRANTTYPE=authorization_code
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_AUTHORIZATIONURI=http://<open_id_provider_url>/somepath/auth
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_USERNAMEATTRIBUTE=preferred_username
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_JWKSETURI=http://<open_id_provider_url>/somepath/keys
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_TOKENURI=http://<open_id_provider_url>/somepath/token

Configure storage services

Specify the details for connecting to the storage services required for Allure TestOps.

  • Connection to the Redis storage server

    • SPRING_DATA_REDIS_HOST — server hostname.
    • SPRING_DATA_REDIS_PORT — server port.
    • SPRING_DATA_REDIS_PASSWORD — password for connecting to the storage.

  • Connection to the PostgreSQL databases

    • SPRING_DATASOURCE_URL — database location in the JDBC URL format.
    • SPRING_DATASOURCE_USERNAME — username for connecting to the database.
    • SPRING_DATASOURCE_PASSWORD — password for connecting to the database.

  • Connection to the RabbitMQ server

    • SPRING_RABBITMQ_HOST — server hostname.
    • SPRING_RABBITMQ_PORT — server port.
    • SPRING_RABBITMQ_USERNAME — username for connecting to the message queue.
    • SPRING_RABBITMQ_PASSWORD — password for connecting to the message queue.

  • Connection to the S3-compatible storage server

    • ALLURE_BLOBSTORAGE_S3_ENDPOINT — server URL.
    • ALLURE_BLOBSTORAGE_S3_BUCKET — S3 bucket name.
    • ALLURE_BLOBSTORAGE_S3_REGION — S3 region name.
    • ALLURE_BLOBSTORAGE_S3_ACCESSKEY — access key for connecting to the bucket.
    • ALLURE_BLOBSTORAGE_S3_SECRETKEY — secret key for connecting to the bucket.

Some additional settings can be modified to fine-tune the performance or support non-standard configurations of the storage services. Check the comments in the testops.conf file and consult the Qameta support team if necessary.

First start

When you start your Allure TestOps installation for the first time, you need to activate it by providing the license key. You should have received the license key in an email from the Qameta sales team.

  1. Open a terminal application.

  2. Restart the services to apply the changes in the configuration file.

    sudo systemctl restart testops

    Restarting all the services of Allure TestOps takes some time. Wait for a couple of minutes before proceeding to the next step.

  3. Soon after startup, Allure TestOps will send an invitation email to the address that you specified in ALLURE_MAIL_ROOT. Check the inbox and click the Accept invite link in the email.

    If you get an “Unable to connect” or “This site can't be reached” error in the browser, it may indicate that some services are still initializing. Normally, the initialization takes no more than a couple of minutes.

    If the web browser still cannot open the page after five minutes, see the Troubleshooting section.

  4. In the invitation accept form, fill in the administrator's full name and the credentials that will be used in the login form: Username and Password. The Username must be unique within the Allure TestOps instance.

    Click Continue.

  5. In the activation form, enter the license key that you got from Qameta sales team. Make sure to paste the key without any extra spaces or other characters.

    Click Activate license.

Managing services status

Start services

To start Allure TestOps, open a terminal application and run the command:

sudo systemctl start testops

Stop services

To stop Allure TestOps, open a terminal application and run the command:

sudo systemctl stop testops

Restart services

To restart Allure TestOps, open a terminal application and run the command:

sudo systemctl restart testops

Upgrading

Before you begin, make sure to read the release notes for the Allure TestOps version you are upgrading to. The release notes may contain crucial information on how to adapt your configuration files or migrate your data to the new version of Allure TestOps. In case you are skipping one or more versions, read the release notes for the skipped versions, too.

  1. Open a terminal application.

  2. Update the parameter that specifies the package version to install.

    Note that you must paste this command as a whole, without running its lines separately. Before executing the command, replace 5.7.0 with the version you are upgrading to.

    cat <<EOF | sudo tee /etc/apt/preferences.d/qameta
Package: testops
Pin: version 5.7.0
Pin-Priority: 1000
EOF

  3. Refresh the index of available packages.

    sudo apt update

  4. Reinstall the package.

    sudo apt install -y testops

  5. If necessary, modify your configuration files according to the relevant release notes.

  6. Restart Allure TestOps.

    sudo systemctl restart testops

Uninstalling

To uninstall the Allure TestOps instance:

  1. Open a terminal application.

  2. Remove the Allure TestOps packages:

    sudo apt autoremove testops-*

  3. Remove your configuration files:

    sudo rm -rf /opt/testops

Troubleshooting

If you run into any issues, please check our FAQ page.

Also, in case of any troubles, do not immediately bring Allure TestOps down and up. We need the log files of each component to understand what has happened.

If you encounter an issue not covered in the FAQ, feel free to create a support ticket using your corporate email address. Please include the following information in the ticket:

  1. Description of the problem you are experiencing.
  2. Versions of Allure TestOps and all extra components you are having problems with (allurectl, integration plugins, etc.).
  3. Logs from your system as attachments to the ticket (see the details below). Please only send us the logs described below and only as an attachment.
journalctl -f -n 100 -u testops

where:

  • f - to follow the journal, i.e. all the new lines will be shown on the screen
  • n 100 - the number of journal entries to show
  • u name - name of a unit

Getting logs

By default, all components write logs to stdout. You can get the logs using journalctl:

journalctl --no-tail -u testops > testops.log
© Qameta Software Inc. All rights reserved.