Skip to content

Latest commit

 

History

History
262 lines (166 loc) · 8.69 KB

repository.md

File metadata and controls

262 lines (166 loc) · 8.69 KB
Raw
description
Information about the PowerShell Universal repository.

Repository

The configuration data for PowerShell Universal is primarily stored within the repository. By default, the repository folder can be found in %ProgramData%\UniversalAutomation\Repository. You can adjust the location of the repository by editing the appsettings.json file.

The repository contains PowerShell scripts and XML files that are produced when using the PowerShell Universal admin console. The repository folder is also watched for changes so any change made on disk will cause the system to reload the file and reconfigure the platform. When using Git integration, the repository folder is what is synchronized with the git remote.

All configuration cmdlets are part of the Universal module.

What's Stored in the Repository

Files stored in the repository are stored as plain text to allow for easy differencing with source control tools.

  • Authentication
  • Apps
  • Endpoints
  • Environments
  • Licenses
  • Login Pages
  • Pages
  • Published Folders
  • Rate Limits
  • Roles
  • Schedules
  • Scripts
  • Settings
  • Tags
  • Triggers

What's Not Stored in the Repository

These entities are stored within the PowerShell Universal database.

  • App Tokens
  • Identities
  • Job History

Editing the Repository

You can edit the repository files directly in the admin console by navigating to Settings \ Files. The editor allows you to create files and folders and edit any file within the repository directory.

Configuration Scripts

Authentication.ps1

{% hint style="info" %} Stored in .universal\authentication.ps1 {% endhint %}

This script is responsible for configuring forms authentication. If forms authentication is not being used, this file is ignored.

You can use the Set-PSUAuthentication cmdlet in this file.

Dashboards.ps1

{% hint style="info" %} Stored in .universal\dashboards.ps1 {% endhint %}

This script is responsible for registering PS1 files are apps within the system. Each command contains the meta-data for the app including name, base URL, and environment.

You can use the New-PSUApp cmdlet in this file.

Endpoints.ps1

{% hint style="info" %} Stored in .universal\endpoints.ps1 {% endhint %}

This script is responsible for defining all the API endpoints within the PowerShell Universal instance.

You can use the New-PSUEndpoint cmdlet in this file.

Environments.ps1

{% hint style="info" %} Stored in .universal\environments.ps1 {% endhint %}

This script is responsible for defining all the environments within PowerShell Universal.

You can use the New-PSUEnvironment cmdlet in this file.

Licenses.ps1

{% hint style="info" %} Stored in .universal\licenses.ps1 {% endhint %}

This script is responsible for defining the license used in PowerShell Universal.

You can use the Set-PSULicense cmdlet in this file.

Set-PSULicense -Key "<License></License>"

LoginPage.ps1

{% hint style="info" %} Stored in .universal\loginPage.ps1 {% endhint %}

This script is responsible for configuring a custom login page.

You can use the New-PSULoginpage and New-PSULoginPageLink in this file.

Initialize.ps1

{% hint style="info" %} Stored in .universal\initialize.ps1 {% endhint %}

This script runs before any configuration is done within PowerShell Universal. The server is running but none of the services have started. This is useful for install modules or configuring secret vaults before discovery of those resources are started.

Middleware.ps1

{% hint style="info" %} Stored in .universal\initialize.ps1 {% endhint %}

Allows for customization of the HTTP requests in PowerShell Universal.

PublishedFolders.ps1

{% hint style="info" %} Stored in .universal\publishedFolders.ps1 {% endhint %}

This script is responsible for configuring published folders.

You can use the New-PSUPublishedFolder cmdlet in this file.

RateLimits.ps1

{% hint style="info" %} Stored in .universal\rateLimits.ps1 {% endhint %}

This script is responsible for configuring rate limits.

You can use the New-PSURateLimit cmdlet in this file.

Roles.ps1

{% hint style="info" %} Stored in .universal\roles.ps1 {% endhint %}

This script is responsible for configuring roles.

You can use the New-PSURole cmdlet in this file.

Schedules.ps1

{% hint style="info" %} Stored in .universal\schedules.ps1 {% endhint %}

This script is responsible for configuring schedules.

You can use the New-PSUSchedule cmdlet in this file.

Scripts.ps1

{% hint style="info" %} Stored in .universal\scripts.ps1 {% endhint %}

This script contains the meta-data for scripts. Actual scripts can be stored anywhere. The path that is included is relative to the repository. Full path names are also allowed.

You can use the New-PSUScript cmdlet in this file.

Settings.ps1

{% hint style="info" %} Stored in .universal\settings.ps1 {% endhint %}

This script is responsible for configuring system settings.

You can use the Set-PSUSetting cmdlet in this file.

Tags.ps1

{% hint style="info" %} Stored in .universal\tags.ps1 {% endhint %}

This script is responsible for configuring tags.

You can use the New-PSUTag cmdlet in this file.

Triggers.ps1

{% hint style="info" %} Stored in .universal\triggers.ps1 {% endhint %}

This script is responsible for configuring triggers.

You can use the New-PSUTrigger cmdlet in this file.

Variables

{% hint style="info" %} Stored in .universal\variables.ps1 {% endhint %}

This script is responsible for configuring variables.

You can use the New-PSUVariable cmdlet in this file.

Custom Configuration Script

A custom configuration script can be executed within the configuration process. The path to the configuration script can be defined in appsettings.json or as an environment variable.

{% code title="appsettings.json" %}

"Data": {
    "ConfigurationScript": "customScript.ps1"
}

{% endcode %}

{% code title="Environment Variable" %}

$Env:Data__ConfigurationScript = "customScript.ps1"

{% endcode %}

You can chose to return items such as endpoints, scripts or dashboards from the script. Additionally, you can use this script to configure resources like modules and secret vaults before the system is started. The custom configuration script is run before any other configuration scripts.

Read-Only Configuration Sections

Read-Only sections allow you to include script in your configuration files that will not be touched by changes in the admin console. This allows you to run additional logic, generate resources dynamically and create classes for use in OpenAPI schemas.

The PSUHeader region is placed at the top of your script. PSUFooter is placed at the bottom.

#region PSUHeader 

1..100 | ForEach-Object {
    New-PSUEndpoint -Url "/endpoint/$_" -Endpoint {

    }
}

#endregion

New-PSUEndpoint -Url "/user" -Endpoint {

}

#region PSUFooter
#endregion