search

Regular release installation

This page provides a step-by-step walkthrough of the installation wizard for performing a Regular Release installation of SigningHub. This mode is designed to apply a new SigningHub release to an already deployed Docker-based environment, updating the existing services while preserving the current configuration and database. The wizard guides you through package detection, container validation, and controlled service updates to ensure a smooth and reliable release deployment.

hashtag
Run Interactive Installation

Run the included script to launch the installation wizard. It will detect existing containers, validate the regular release package, and update the running services.

# Make script executable
chmod +x startup.sh

# Run interactive installation wizard
./startup.sh

# To run the installation wizard with progress details and logs
VERBOSE=1 ./startup.sh

hashtag
Wizard Flow

The installation wizard takes you through these steps:

hashtag
Step 1: Select Installation Type

The wizard presents three options:

Select an option (e.g., 3 for REGULAR RELEASE) and confirm output:

hashtag
Step 2: Detect Running Containers

The wizard scans the environment to identify running SigningHub containers and validates their health status.

Detected containers are confirmed as healthy:

Dependency validation is performed automatically:

The wizard determines the update order to ensure service dependencies are respected:

hashtag
Step 3: Regular Release Package Detection

The wizard automatically detects the regular release package available in the directory.

hashtag
Step 4: Prepare Regular Release and Update Containers

The wizard confirms the update plan and informs you that containers will be updated in dependency order.

You are prompted to confirm before proceeding:

The wizard updates each container sequentially, ensuring stability throughout the process.

Admin API Module

API Module

Core Module

Admin Module

Web Module

hashtag
Regular Release Update Summary

Once all modules are updated, the wizard displays a final summary.

circle-info

  1. The Docker images for SigningHub were built using Debian GNU/Linux as the base operating system.

  2. To stop and remove all containers, networks, and volumes, run the following command. This will completely remove the deployed containers and associated data volumes. docker compose --profile first-time down -v If you want to run the installer a second time, you should first stop and remove any already running containers. After that, run the ./state-remove.sh script to remove the state, and then you can initialise the startup again.

  3. If you want to view other Docker-related commands, refer to the README.md file in the SigningHub Docker Package.

  4. The Regular Release mode does not modify database configurations or data.

  5. All containers are updated in-place using the existing configuration.

  6. It is recommended to take a database backup before performing a regular release, especially in production environments.

  7. If no running SigningHub containers are detected, the regular release option cannot proceed.

PreviousInstallation with existing databaseNextInstallation via domain

Last updated

Was this helpful?