Deploy a keystore to the filesystem

Octopus.JavaDeployCertificate exported 2026-07-22 by Octopus Deploy belongs to ‘Certificate’ category.

Deploy a certificate to a Java keystore on the target filesystem.

Parameters

When this step is included in a project’s deployment process, the parameters below can be set.

Certificate variable

Java.Certificate.Variable (required)

The certificate variable to deploy.

Keystore filename

Java.Certificate.KeystoreFilename (required)

The path of the keystore file to create. This must be an absolute path, the parent directory must exist, and the path must include the keystore filename. If the file exists, it will be overwritten.

Example: /opt/server/conf/keys.store

Private key password

Java.Certificate.Password

An optional password assigned to the private key. If left blank, the default password of ‘changeit’ will be used.

Keystore alias

Java.Certificate.KeystoreAlias

The optional alias to assign the private key to. If left blank, the default alias of ‘Octopus’ will be used.

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "deploy-keystore" {
    name = "Deploy Keystore"
    properties = {
        Octopus.Action.TargetRoles = "app-server"
    }

    action {
        action_type = "Octopus.JavaDeployCertificate"
        properties = {
            Java.Certificate.KeystoreAlias = "myalias"
            Java.Certificate.KeystoreFilename = "/opt/app/keystore.jks"
            Java.Certificate.Variable = "Certificates-MyCert"
            Octopus.Action.RunOnServer = "false"
        }
    }
}

Page updated on Wednesday, July 22, 2026