CodeSign Secure Documentation
  • Overview
    • About CodeSign Secure
    • Getting Started
    • Documentation Guide
    • Portal Overview
    • Troubleshooting
      • FAQ
    • Glossary
  • Reference Guide
    • Header Bar
      • CodeSign Secure Documentation
      • Swagger API
      • Profile Section
    • Dashboard
      • Key Performance Indicators
      • Issued Certificates
      • Signatures Generated
      • HSM Health Check
    • Keys and Certificates
      • Key and Certificate Lifecycle
    • App Management
    • Signing Requests
      • Approval Workflows
    • Signing Tools
    • Reports
      • Signing Request Report
      • Audit Trail
      • Certificate Report
      • Client Report
    • Logs
    • System Setup
      • Identity Store
      • Backup
      • User
      • Roles and Permissions
      • Email
      • Signing Projects
      • SSL/TLS Management
      • Environment
      • Plugins
  • Setup & Architecture
    • Identity and Access Control
    • Architecture and Concepts
    • Installation
      • Windows
        • Installing the Server
        • Ports and Protocols
        • High Availability and Backup
        • Upgrades and Compatibility
    • Security
      • Security Hardening Checklist
      • Client Authentication
      • Designing Signing Policies
  • Release Notes
    • Releases for 2026
      • v3.2.1
    • Releases for 2025
      • v3.2.0
    • Releases for 2024
      • v3.1.0
  • API Reference
    • Getting Started
    • Authorizing Requests
    • Securing API Access
    • Request and Response Conventions
    • Endpoint Reference
      • Signing
      • Signing Requests
      • Certificates
      • Applications and Environments
      • User Management
      • Permissions
      • Email
      • System Setup
      • Reports
      • Dashboard
      • License
  • Integration Guides
    • Signing Capabilities
      • Supported Formats and Platforms
      • Timestamping
      • Windows Signing - SignTool
        • Signing
        • Macro Signing
      • Apple Signing
      • AppX & MSIX Signing
      • Visual Studio ClickOnce
      • Jar Signing
      • Sign HLK/HCK using CodeSign Secure
      • NuGet Signing
      • Mage Signing
      • Sign OVA/OVF using Encryption Consulting’s Utility Tool
      • Utility Tool for code signing
      • Container Signing
      • PKCS11 Wrapper
        • APK Signing
        • OpenSSL Signing
        • XML Signing
        • JSign Tool Signing
        • Jarsigner Signing
        • GPG2, Debian & RPM Signing
      • Reproducible Build
        • Automated Hash Validation
        • Reproducible Build Process Flow
        • Pipeline Script Components
        • Hash Validation
    • CI/CD Integration
      • GitHub Actions
      • Jenkins
      • GitLab
      • Azure DevOps
      • TeamCity
      • Bamboo
      • Securing CI/CD Credentials

Installing the Server

Install CodeSign Secure on a single Windows Server 2022 machine with the CodeSign Secure installer, then verify that it works.

Requirements
Server hardware
ResourceRequirement
Operating systemWindows Server 2022
CPUAt least 8 cores
Memory32 GB RAM (recommended)
Storage250 GB. Increase it if you keep backups and logs on the server for a long time.
HSMFIPS 140-2 Level 3 HSM: Entrust nShield, Thales Luna, Securosys Primus, or Utimaco SecurityServer. For the supported firmware and software versions, see Supported formats and platforms.
Prepare before you run the installer
  • A DNS name for the portal, for example codesign.example.com, that resolves to the server or to your load balancer.

  • A local Administrator account on the server.

  • The HSM client software installed and connected to your HSM. The installer asks for the HSM type.

  • For Entrust nShield: openssl.exe present in C:\Program Files\nCipher\nfast\bin\. The installer uses it to create the internal certificate authorities.

  • If you use Azure AD sign-in, the app registration values: Client ID, client secret, Callback URL and Connection URL. See Identity Store.

What the installer sets up
ItemDetails
CodeSign Secure BackendThe REST API.
CodeSign Secure FrontendThe portal.
ApacheWeb server that publishes the portal and API over HTTPS. Controlled from the Apache Monitor in the taskbar.
MongoDB and MongoDB CompassInstalled if not already present.
PythonInstalled if not already present (3.10.11 or later is required).
Microsoft Build Tools x64Installed if not already present.
Installation folderC:\CodeSignSecure by default.
Install CodeSign Secure
  1. Download the CodeSign Secure ISO file and mount or extract it. It contains the installer and the icons and src folders.

  2. Right-click CodeSign Secure Installer and select Run as administrator.

    Run the CodeSign Secure installer as administrator
  3. On the welcome page, select Next.

    Installer welcome page
  4. Read the license agreement, select I accept the terms and conditions and select Next.

    License agreement
  5. On Choose Installation Options, keep or change the Installation Folder, select both CodeSign Secure – BACKEND and CodeSign Secure – FRONTEND, and select Next. Confirm the path and the two services with Yes.

    Installation options and confirmation
  6. In Frontend URL, enter the portal DNS name without https://, for example codesign.example.com, and select Install.

    Frontend URL
  7. Wait while the installer checks for and installs MongoDB, MongoDB Compass, Python and the Build Tools.

    Installer installing dependencies
  8. When the PowerShell window asks for certificate authority details, enter the distinguished name for each CA:

    CAPurpose
    Root CARoot of the code-signing certificates issued inside CodeSign Secure
    Issuing CAIssues code-signing end-entity certificates
    Root CA for P12 authenticationIssues the client authentication certificates

    Each CA asks the standard OpenSSL questions: two-letter country code, state or province, locality (city), organization, organizational unit, common name, and email address. Enter the state and city in their own fields. You can leave the challenge password and optional company name blank.

    Certificate authority details in PowerShell
  9. When the seed-data script runs, answer the prompts to create the first administrator:

    PromptWhat to enter
    Enter your HSM TypeYour HSM type, for example NCIPHER for Entrust nShield
    Enter Client ID, Secret Key, Callback URL, Connection URLYour Azure AD app registration values. See Identity Store.
    ID of the user who created / last modified this entry1
    Enter AD Typeazure
    username, first name, last name, email, passwordThe first System Admin account.

    Important: The console shows what you type, including the client secret and password. Close the window when the script finishes, don’t take screenshots of it, and change the password after your first sign-in if anyone else saw it.

    Seed-data prompts

    The values in this screenshot are placeholders.

  10. When CodeSign Secure was successfully installed! appears, select OK. Make sure every task in the PowerShell window and the installation wizard has finished.

    CodeSign Secure was successfully installed
  11. Start the Apache Monitor from the taskbar and make sure Apache is running.

Verify the installation
CheckExpected result
Open https://<your domain>/ in a browserThe CodeSign Secure sign-in page loads.
Sign in with the System Admin account registered in the previous stepThe Dashboard opens.
Dashboard > HSM Health CheckStatus is Active, and the HSM model and serial number are shown.
CodeSign Secure dashboard after the first sign-in
After installation
  • Follow the first-time configuration order.

  • Open only the ports listed in Ports and Protocols.

  • Work through the Security hardening checklist.

Troubleshooting the installation
SymptomWhat to do
A dependency fails to installSelect Open Logs in the installer to find the failing step.
The installer can’t create the certificate authoritiesFor nShield, check that openssl.exe exists in C:\Program Files\nCipher\nfast\bin\.
The sign-in page doesn’t loadCheck that Apache and both CodeSign Secure services are running and that the Frontend URL resolves to this server and is whitelisted in your firewall configurations.
HSM Health Check shows InactiveCheck the HSM client with the vendor tool, for example enquiry for nShield or vtl verify for Luna. Try to restart the HSM and apache service and check again on the portal.
On this Page:
Support Privacy Policy Terms of Service

Copyright Encryption Consulting LLC. All rights reserved.