Deploy to WildFly or EAP

Octopus.WildFlyDeploy exported 2026-07-22 by Octopus Deploy belongs to ‘JavaAppServer’ category.

Deploy a Java application to WildFly 10+ or Red Hat JBoss EAP 6+ via the management CLI.

Parameters

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

Management host or IP

WildFly.Deploy.Controller (required)

The hostname or IP address of the application server that the package will be uploaded to. This value is relative to the host that is executing the step.

Default: localhost

Example: localhost

Management port

WildFly.Deploy.Port (required)

The management port that the application server is listening to. For WildFly 10+ and Red Hat JBoss EAP 7+, the default is 9990. For Red Hat JBoss EAP 6, the default is 9999.

Default: 9990

Example: 9990

Management protocol

WildFly.Deploy.Protocol (required)

The management protocol that the application server is listening to. For WildFly 10+ and Red Hat JBoss EAP 7+, the default is remote+http. For Red Hat JBoss EAP 6, the default is remoting.

Default: remote+http

Example: remote+http

Management user

WildFly.Deploy.User

The username to use with the management interface. Typically configured via the add-user script. By default WildFly does not require credentials for local connections.

Management password

WildFly.Deploy.Password

The password to use with the management interface. By default WildFly does not require credentials for local connections.

Deployment name

WildFly.Deploy.Name

An optional field to override the name of the deployed artifact. For example, setting this field to ‘myapp.war’ will result in the deployment having that name in WildFly regardless of the package name.

Example: myapp.war

Standalone or Domain Server

WildFly.Deploy.ServerType

Select the kind of server you are deploying to.

Allowed values: Standalone, Domain

Default: Standalone

Enable the deployment

WildFly.Deploy.Enabled

Whether to deploy the application in an enabled or disabled state to a standalone server. This value has no effect when deploying to domain servers.

Allowed values: True, False

Default: True

Enabled server groups

WildFly.Deploy.EnabledServerGroup

A comma-separated list that defines the domain server groups where the deployment will be assigned and enabled. This value is ignored when deploying to a standalone instance.

Disabled server groups

WildFly.Deploy.DisabledServerGroup

A comma-separated list that defines the domain server groups where the deployment will be assigned and disabled. This value is ignored when deploying to a standalone instance.

Optional features

Enable features by adding their IDs to Octopus.Action.EnabledFeatures (a comma-separated list).

Custom Deployment Scripts `Octopus.Features.CustomScripts`

Execute scripts during the deployment (pre-deploy, deploy, post-deploy) without embedding them in your package.

Octopus.Action.CustomScripts.PreDeploy.

Octopus.Action.CustomScripts.PreDeploy.<ext>

Pre-deploy script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Octopus.Action.CustomScripts.Deploy.

Octopus.Action.CustomScripts.Deploy.<ext>

Deploy-phase script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Octopus.Action.CustomScripts.PostDeploy.

Octopus.Action.CustomScripts.PostDeploy.<ext>

Post-deploy script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Structured Configuration Variables `Octopus.Features.JsonConfigurationVariables`

Replace settings in JSON, YAML, XML, and Java Properties files with Octopus variables. Enabled by default for package deployments.

Octopus.Action.Package.JsonConfigurationVariablesTargets

Octopus.Action.Package.JsonConfigurationVariablesTargets

Newline-separated list of target files (e.g. appsettings.json). Wildcards supported.

Substitute Variables in Templates `Octopus.Features.SubstituteInFiles`

Transforms files using the Octopus #{Variable} substitution syntax. Enabled by default for package deployments.

Octopus.Action.SubstituteInFiles.TargetFiles

Octopus.Action.SubstituteInFiles.TargetFiles

Newline-separated list of file names to transform (relative to package). Wildcards supported.

Octopus.Action.SubstituteInFiles.OutputEncoding

Octopus.Action.SubstituteInFiles.OutputEncoding

Encoding name for the output file (e.g. utf-8). Optional.

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "deploy-to-wildfly" {
    name = "Deploy to WildFly"
    properties = {
        Octopus.Action.TargetRoles = "wildfly-server"
    }

    action {
        action_type = "Octopus.WildFlyDeploy"
        properties = {
            Octopus.Action.Package.DownloadOnTentacle = "False"
            Octopus.Action.Package.FeedId = "octopus-server-built-in"
            Octopus.Action.Package.PackageId = "MyApp"
            Octopus.Action.RunOnServer = "false"
            WildFly.Deploy.Controller = "localhost"
            WildFly.Deploy.Enabled = "True"
            WildFly.Deploy.Port = "9990"
            WildFly.Deploy.Protocol = "remote+http"
            WildFly.Deploy.ServerType = "Standalone"
        }

        packages {
            acquisition_location = "Server"
            feed = "octopus-server-built-in"
            package_id = "MyApp"
        }
    }
}

Page updated on Wednesday, July 22, 2026