Ironman Software Script Library

Public library of scripts maintained by Ironman Software.

What is this repository for?

This repository is a collection of scripts that are maintained by Ironman Software. This repository can be used directly with PowerShell Universal version 4 and 5.

Categories

Active Directory

Contains scripts that are specific to Active Directory.

Apps

Contains full Blazor and PowerShell apps that can be run with PowerShell Universal.

Notifications

Contains scripts that can be used to send notifications like email and chat apps.

PowerShell

Contains general purpose PowerShell scripts.

Universal

Contains scripts that are specific to PowerShell Universal.

Windows

Contains scripts that are specific to Windows environments.

Usage

PowerShell

You can use this repository outside of PowerShell Universal by installing the release to your local machine. PowerShell Universal uses PSResourceGet. You will need to install this module.

Install-Module -Name Microsoft.PowerShell.PSResourceGet -Force -SkipPublisherCheck -AllowClobber -Scope CurrentUser -ErrorAction SilentlyContinue
Invoke-WebRequest -Uri 'https://github.com/ironmansoftware/scripts/releases/download/0.0.5/library.zip' -OutFile 'C:\downloads\modules.zip'
Expand-Archive -Path 'C:\repos\scripts\modules.zip' -DestinationPath 'C:\repos\scripts\modules'
Register-PSRepository -Name 'PSUScriptLibrary' -SourceLocation 'C:\repos\scripts\modules'

PowerShell Universal v5

This repository is automatically installed with PowerShell Universal v5 and integrated into the admin console. You can access the library by clicking Platform \ Library.

The library contains a collection of modules that you can use in your environment. You can install these modules directly from the library page.

You can also access the library from various resource pages.

Solutions installed from the library will appear in the Modules page and their resources will automatically be added.

PowerShell Universal v4

This repository can be installed with PowerShell Universal v4 by registering it as a module repository.

Installation

PowerShell Universal uses PSResourceGet. You will need to install this module.

Install-Module -Name Microsoft.PowerShell.PSResourceGet -Force -SkipPublisherCheck -AllowClobber -Scope CurrentUser -ErrorAction SilentlyContinue

To install this repository with PowerShell Universal v4, you can use the following command.

Invoke-WebRequest -Uri 'https://github.com/ironmansoftware/scripts/releases/download/0.0.5/library.zip' -OutFile 'C:\repos\scripts\modules.zip'
Expand-Archive -Path 'C:\repos\scripts\modules.zip' -DestinationPath 'C:\repos\scripts\modules'
Register-PSRepository -Name 'PSUScriptLibrary' -SourceLocation 'C:\repos\scripts\modules'

Add Resources to PSU

You can add resources found in this library to your PSU instance by visiting the modules page. Click Platform \ Modules \ Repositories and select the PSUScriptLibrary repository.

Versioning

During the prerelease versions of PowerShell Universal v5, we will be incrementing the minor version of the script library for releases. Once PowerShell Universal v5 reaches general availability, the release versions will match the latest PSU v5 version.

Contribution guidelines

If you would like to contribute to this repository, please submit a pull request. We accept any PowerShell script that you would like to share with the community. We recommend structure it so that it can be used with PowerShell Universal.

Structure

Each script should be in a folder that contains the script and a psd1 file that contains the metadata for the script. To include resources in PowerShell Universal, you can create a .universal folder. These will be automatically exposed in PSU when the module is imported. You can view examples within the repository to see how this is accomplished.

Tags, images and description of your module will appear directly in the platform.

Tags

The following tags are used to categorize modules in PowerShell Universal

• script - Contains a script resource
• powershell-app - Contains a PowerShell App
• blazor-app - Contains a Blazor App

Documentation

We prefer that you include comment based help. A readme.md is also useful to better describe your module or solution. The readme content will be displayed in PowerShell Universal.

Tests

We currently do not require tests but prefer any tests are written in Pester. We will run these tests during CI builds.

Building

The repository is automatically build using the build.ps1 script. It finds all PSD1 files and generates nuget packages for each module. These will be stored in the output folder. They should not be checked in. A .gitignore has been created to prevent this.