https://github.com/atlassianps/atlassianps.configuration
A module for AtlassianPS modules to use for managing connections
https://github.com/atlassianps/atlassianps.configuration
Last synced: over 1 year ago
JSON representation
A module for AtlassianPS modules to use for managing connections
- Host: GitHub
- URL: https://github.com/atlassianps/atlassianps.configuration
- Owner: AtlassianPS
- License: mit
- Created: 2018-05-01T16:44:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-06T18:41:58.000Z (over 7 years ago)
- Last Synced: 2024-10-29T21:48:56.457Z (over 1 year ago)
- Language: PowerShell
- Homepage: https://atlassianps.org/module/AtlassianPS.Configuration
- Size: 716 KB
- Stars: 4
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
---
layout: module
permalink: /module/AtlassianPS.Configuration/
---
# [AtlassianPS.Configuration](https://atlassianps.org/module/AtlassianPS.Configuration)
[](https://github.com/AtlassianPS/AtlassianPS.Configuration/releases/latest)
[](https://dev.azure.com/AtlassianPS/AtlassianPS.Configuration/_build/latest?definitionId=8)
[](https://www.powershellgallery.com/packages/AtlassianPS.Configuration)
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](https://atlassianps.org/slack)
[SlackLogo]: https://atlassianps.org/assets/img/Slack_Mark_Web_28x28.png
---
## 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)
```powershell
# One time only install:
Install-Module AtlassianPS.Configuration -Scope CurrentUser
# Check for updates occasionally:
Update-Module AtlassianPS.Configuration
```
### Usage
> This example uses [ConfluencePS](https://atlassianps.org/docs/ConfluencePS) for illustration.
> This example uses [splatting](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_splatting).
```powershell
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](https://atlassianps.org/docs/AtlassianPS.Configuration) and in the console.
### Contribute
Want to contribute to AtlassianPS? Great!
We appreciate [everyone](https://atlassianps.org/#people) who invests their time to make our modules the best they can be.
Check out our guidelines on [Contributing] to our modules and documentation.
## Useful links
* [Source Code]
* [Latest Release]
* [Submit an Issue]
* [Contributing]
* How you can help us: [List of Issues](https://github.com/AtlassianPS/AtlassianPS.Configuration/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs)
## 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.
[AtlassianPS]: https://atlassianps.org/
[PowerShell Gallery]: https://www.powershellgallery.com/
[Source Code]: https://github.com/AtlassianPS/AtlassianPS.Configuration
[Latest Release]: https://github.com/AtlassianPS/AtlassianPS.Configuration/releases/latest
[Submit an Issue]: https://github.com/AtlassianPS/AtlassianPS.Configuration/issues/new
[MIT license]: https://github.com/AtlassianPS/AtlassianPS.Configuration/blob/master/LICENSE
[Contributing]: http://atlassianps.org/docs/Contributing