AtlassianPS.Configuration

GitHub release Build status PowerShell Gallery License

AtlassianPS.Configuration is a module that offers a common set of tools to the AtlassianPS products to handle user-specific configuration.

Join the conversation on SlackLogo AtlassianPS.Slack.com


Instructions

Installation

This module does not need to be installed manually.
AtlassianPS products which use this module will install it automatically using the PowerShell Gallery.

Install AtlassianPS.Configuration from the PowerShell Gallery! Install-Module requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link)

# One time only install:
Install-Module AtlassianPS.Configuration -Scope CurrentUser

# Check for updates occasionally:
Update-Module AtlassianPS.Configuration

Usage

This example uses ConfluencePS for illustration.
This example uses splatting.

Import-Module ConfluencePS   # AtlassianPS.Configuration is imported automatically

$serverData = @{
    # BaseURL of the server
    Uri = "https://powershell.atlassian.net/wiki"
    # Name with which you want to address this server
    ServerName = "AtlassianPS - wiki"
    # Type of the Atlassian product
    Type = "Confluence"
}
Set-AtlassianServerConfiguration @serverData

Get-ConfluenceSpace -Server "AtlassianPS - wiki"

You can find the full documentation on our homepage and in the console.

Contribute

Want to contribute to AtlassianPS? Great! We appreciate everyone who invests their time to make our modules the best they can be.

Check out our guidelines on Contributing to our modules and documentation.

Disclaimer

Hopefully this is obvious, but:

This is an open source project (under the MIT license), and all contributors are volunteers. All commands are executed at your own risk. Please have good backups before you start, because you can delete a lot of stuff if you’re not careful.