Archive database
Release stores completed releases in a database that is separate from the repository: the archived database. Besides the completed releases, metadata for reporting is stored in this database.
Release stores completed releases in a database that is separate from the repository: the archived database. Besides the completed releases, metadata for reporting is stored in this database.
This topic discusses how to set up SSO authentication for external users that are in external IDPs.
This topic describes how to create a backup and how to restore from that backup. It is a best practice to create regular backups of your Release server.
This topic describes how to install Release in a standard installation - either a simple setup with the default configuration, or a manual setup in which you can choose specific options. If you are installing Release in a production-ready environment that includes options like a separate database server, load balancing for your Release servers, an active/active cluster configuration for your Release servers, and other security, monitoring, and performance considerations, see Production environment install.
You can automate the cleanup of old releases by setting up a template with a cleanup script that will be periodically triggered by the criteria that you provide. You can use this procedure in cases where many releases are in a failed state that are older than the specified period of time.
This topic describes how to install and upgrade Release as a cluster. Running Release in a cluster mode lets you have a Highly Available (HA) Release setup. Release supports the following HA mode.
This topic describes how to configure Release to use an Atlassian Crowd to authenticate users and retrieve role (group) membership. In Release, Atlassian Crowd users and groups become principals that you can assign to roles. Global permissions are assigned at the role level.
With the maximum size of the HTTP request header set to 8KB (8192 bytes) it becomes difficult to pass the authentication tokens and scopes in headers. Hence with Release 24.1, you can use the server.max-http-request-header-size parameter to configure the maximum size of the HTTP request header that the Release server can accept. Setting an appropriate value for this parameter depends on the specifics of your application and environment.
This topic describes how to configure Keycloak to authenticate Release users and REST API calls (using the Bearer Token Authorization).
This topic explain how to Configure roles in Release.
This topic explains how to configure task access Release, allowing you to manage who can view or execute specific tasks within a release.
This topic outlines how to configure session timeout and session storage settings in Release.
This topic describes how to connect Release to Deploy servers, enabling seamless integration for deployment automation.
This topic explains how to create a JDBC export hook in Release, allowing you to export data from the release system to a JDBC-compliant database. For more information, see Release export hooks.
You can use the export hook feature to configure Release to run a Jython script for every release that is about to be archived.
In this topic, you will learn how to configure some experimental settings.
The Feature Settings page allows you to toggle or configure the optional features in Digital.ai Release.
In Release you can configure the file upload properties. File upload properties are used to set a limit for the size of uploaded files and to restrict content accepted by Release.
This topic explains how to configure General settings in Release.
This topic provides details about global permissions in Release.
You can use variables to manage information that you don't know in advance or that may change.
This topic provides information about how all completed and aborted releases are archived in Digital.ai Release. These releases are removed from the main repository and stored in a separate internal database called the archive database. This process improves performance and allows for the creation of custom hooks to export release information to external databases or reporting tools.
This topic covers Cross-Site Request Forgery (CSRF), a class of attack that forces an authenticated end user to execute unwanted actions on an application. You can configure CSRF protection in Release.
You can configure GZIP compression in Release. GZIP compression is used to decrease the size of server responses and save bandwidth usage. There is a small overhead of server CPU usage to compress content. It is enabled by default, but you may want to adjust the settings depending on your use case.
This topic explains the sameSite attribute for session cookies in Digital.ai Release 22.1 and later, enhancing security by restricting cookies to first-party or same-site contexts.
This topics provides information about how to install and remove plugins in Release.
This page covers the minimum hardware and software requirements to install and run Digital.ai Release. Also, you will get information about the supported operating systems, databases, web browsers, kubernetes platforms, JDKs, message brokers, upgrade versions, and so on. Ensure that your setup is better than the stated minimum requirements, depending on your site's size and usage pattern. For more assistance, contact Digital.ai support.
This guide provides step-by-step instructions for integrating Digital.ai Release with the Digital.ai Platform.
This topic describes how support Single Sign-On (SSO) by configuring Release to use Integrated Windows Authentication to authenticate users and retrieve role (group) membership without prompting the users for a user name and password. In Release, Active Directory users and groups become principals that you can assign to roles.
This topic describes how to configure Release to use an LDAP repository to authenticate users and retrieve role, group, membership.
This topic outlines the two main types of licenses in Digital.ai Release: the 30-day Trial Edition license and the new bundle license (v4), which includes Essentials, Pro, and Premium Editions.
By default, the Digital.ai Release server writes information, such as: warnings, errors, and log messages to your terminal output and to XLRELEASESERVER_HOME/log/xl-release.log.
You can run Digital.ai Release in maintenance mode, which is a special mode of operating a single Digital.ai Release instance or an entire cluster. The primary use is to boot-up Release in maintenance mode for post-upgrade smoke testing and clean-up activities.
This topic explains how to change the encryption key password and the admin user's password in Release.
Release provides a mechanism to automatically encrypt passwords and enables you to refer to them, so you do not need to store third-party passwords in plain text in configuration files.
This topic describes how to create and use Personal Access Tokens (PAT).
Digital.ai Release runs on the Java Virtual Machine (JVM) and has two classloaders: one for the server itself, and one for the plugins and extensions. A plugin can have a .jar extension. The JAR format is a ZIP archive that bundles a plugin with all of its dependencies.
You can manage your Digital.ai Release plugins directly from the Digital.ai Release user interface. The plugin manager displays the list of installed plugins and their current version. With the plugin manager you can upload a new plugin or a new version of an installed plugin directly from the user interface.
This topic covers the setup of a production environment in Digital.ai Release using an external clustered database for operational and archived data. It also includes configuring PostgreSQL in a hot-standby setup for high availability with standby servers ready to take over if the primary server fails.
This topic provides details about profile settings in Release.
You can clean up the archived releases in the archive database by purging the archived releases.
In this topic, you will learn how to configure the releases, workflows, and triggers settings.
Release features a modular architecture that allows you to change and extend components while maintaining a consistent system.
This topic explores Risk profile settings, which are configurations that help assess and manage the potential risks associated with a release.
This topic describes how to configure Release authentication using the OpenID Connect (OIDC) protocol. OpenID Connect (OIDC) is an identity layer built on top of the OAuth 2.0 protocol and supported by various OAuth 2.0 providers.
This topic outlines the procedure for shutting down or stopping Release using a command prompt or terminal.
In Release, you can configure an SMTP server to send notifications to users via email. This can be for events that occur during the execution of the release.
In Release, you can store template versions inside a folder in a Source Control Management (SCM) tool. This provides easier management of all the artifacts, and provides the possibility to store them together with Releasefiles and Jenkinsfiles, and to configure and to use them from a release pipeline. You can define an SCM connection on a folder level or on a global level in Release.
Internal and External Users
This topic describes how to start the Release server on different operating systems, either interactively or as a background process.
In this topic, you will learn how to configure the task settings.
This topic describes how to install a trial version of Release.
This topic describes how to troubleshoot the Release service.
This topics provides information about creating and configuring a truststore, importing certificates, and adjusting Release settings to ensure secure communication with the Deploy server.
The upcoming version of Digital.ai Release 24.1 requires upgrading to Java 17 as it is the next Long Term Support (LTS) version of the JDK. This ensures that Release has access to the latest Java functionalities and as well as up to date security fixes.
The Release Setup Wizard can generate a self-signed digital certificate for secure communications.
This topic describes the prerequisites, process and considerations for upgrading to the latest version of Release.
This topic explains user management in Digital.ai Release, including how users are identified and authenticated through valid credentials.