Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.3 KB

README-cOctopusServerGoogleAppsAuthentication.md

File metadata and controls

38 lines (29 loc) · 1.3 KB
Raw

README-cOctopusServerGoogleAppsAuthentication

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"
    {
        cOctopusServerGoogleAppsAuthentication "Enable Google Apps authentication"
        {
            InstanceName = "OctopusServer"
            Enabled = $true
            ClientID = "5743519123-1232358520259-3634528"
            HostedDomain = "https://octopus.example.com"
        }
    }
}

SampleConfig

Start-DscConfiguration .\SampleConfig -Verbose -wait

Test-DscConfiguration

Properties

Property Type Default Value Description
InstanceName string The name of the Octopus Server instance. Use OctopusServer by convention unless you have more than one instance.
Enabled boolean $false Whether to enable GoogleApps authentication.
ClientId string The Client ID from the Google Developer console.
HostedDomain string The url of your octopus server.