search

Fresh installation (Custom mode)

This page guides you through the complete installation wizard flow for a fresh installation of SigningHub and ADSS with a custom database configuration. Both MSSQL and Oracle can be used in this mode. In the walkthrough below, Oracle is used as an example, but the steps are identical for MSSQL, except for selecting MSSQL during the database configuration step in the wizard. This approach is recommended when you need to customise database names, credentials, or connection parameters before deploying services.

hashtag
Run Interactive Installation

Run the included script to launch the installation wizard. It will configure your environment, update settings, and start the required containers.

# Convert script to Unix format
dos2unix startup.sh

# 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., 1 for FIRST TIME) and confirm output:

hashtag
Step 2: Configure Mandatory Settings

You will be prompted to enter:

  1. Public Host Configuration

    • IP address or hostname where SigningHub will be accessible.

    • Examples: 192.168.1.100, mydomain.com

    • Wizard output confirms:

  2. SigningHub Package Configuration

    • Select an option (e.g., 1 2) to confirm the SigningHub Package, in case multiple .zip files are available in the directory. In case of a single .zip file, no confirmation will be required.

    • Wizard output confirms:

hashtag
Step 3: Configure ADSS Server

Enter the host IP or domain name where the ADSS Service is deployed:

hashtag
Step 4: Select Database Type

Choose the database to use:

Confirm output:

hashtag
Step 5: Select Installation Mode

Select the installation mode:

Confirm output:

circle-info

  1. Prior to the SigningHub-Docker-v10.0.4-Package, Oracle Database supported only 'Custom Mode'. From the SigningHub-Docker-v10.0.4-Package onwards, both 'Custom Mode' and 'Default Mode' are supported, giving users the option to use either configuration.

hashtag
Step 6: Configure Custom Settings

If you selected Custom Mode, you will configure:

  1. Database Configuration

    • Provide host, database name, username, and password (all fields must be filled or defaults will be used).

    • Default Oracle Values:

      • Host: oracle

      • Port: 1521

      • Service Name: signinghub

      • Authentication: SERVER_AUTH

      • Username: ANCore

      • Password: [Password]

    • Default MSSQL values:

      • Host: mssql

      • Database Name: sh_db_new

      • Username: sa

      • Password: [Password]

  2. Redis Configuration

    • Default Redis URL: redis:6379,password=,ssl=False,abortConnect=False

  3. SMTP Configuration

    • Default SMTP settings:

  4. File Storage Path

    • Default file storage path: /app

circle-info

  1. You may skip any of the above to use defaults. If you choose to configure the database, all fields are mandatory.

hashtag
Step 7: Select Modules to Deploy

Choose which SigningHub services you want to deploy:

Confirm output:

hashtag
Step 8: Configuration Summary

Review the final summary:

hashtag
Step 9: Apply Configuration

Wizard updates all configuration files and confirms:

hashtag
Step 10: Start Installation

The installation now takes place with info and success messages appearing periodically.

Wizard output:

hashtag
Access Information

When installation is complete, the wizard displays the access URLs:

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.

PreviousFresh installation (Default mode)NextInstallation with existing database

Last updated

Was this helpful?