Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.46 KB

README-cOctopusServerSslCertificate.md

File metadata and controls

43 lines (34 loc) · 2.46 KB

README-cOctopusServerSslCertificate

This resource binds a SSL certificate to allow Octopus Server to listen over HTTPS. It binds the certificate stored in the Windows Certificate store identified by the StoreName and Thumbprint to the port that the sever will listen on. This port must match the https entry in the WebListenPrefix element of the cOctopusServer resource.

Sample

First, ensure the OctopusDSC module is on your $env:PSModulePath. Then you can create and apply configuration like this.

Configuration SampleConfig
{
    Import-DscResource -Module OctopusDSC

    Node "localhost"
    {
        cOctopusServerSslCertificate SSLCert
        {
            InstanceName = "OctopusServer"
            Thumbprint = "<Thumbprint string from certificate>"
            Ensure = "Present"
            StoreName = "My"
            Port = 443
        }
    }
}

SampleConfig

Start-DscConfiguration .\SampleConfig -Verbose -wait

Test-DscConfiguration

Properties

Property Type Default Value Description
Ensure string - Present or Absent Present The desired state of the Octopus Server - effectively whether to install or uninstall.
InstanceName string The name of the Octopus Server instance. Use OctopusServer by convention unless you have more than one instance.
Thumbprint string Thumbprint of the SSL certificate to use with Octopus Deploy,
StoreName string - My or WebHosting Which certificate store to look for the thumbprint in.
Port int The port to use SSL on.