Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to installation documentation #269

Merged
merged 2 commits into from
Jun 23, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 18 additions & 34 deletions docs/getting_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,13 @@ sort: 1

`Thycotic.SecretServer` is available to download from the following locations:

- [PowerShell Gallery](https://www.powershellgallery.com/packages/Thycotic.SecretServer/)
- [GitHub Releases](https://github.com/thycotic-ps/thycotic.secretserver/releases/latest)
- [Direct download](https://thyproservices.z20.web.core.windows.net/Thycotic.SecretServer.zip)
- **[Direct download](https://thyproservices.z20.web.core.windows.net/Thycotic.SecretServer.zip) Current Release**
- *[PowerShell Gallery](https://www.powershellgallery.com/packages/Thycotic.SecretServer/) Release 60.4*

Choose one of the following methods to obtain & install the module:

## Option 1: Install from PowerShell Gallery

PowerShell Gallery is the preferred method for installing the module.

1. Open a PowerShell prompt

2. Execute the following command:

```powershell
Install-Module -Name Thycotic.SecretServer -Scope CurrentUser
```

> **Warning** **Windows PowerShell 5.1 or PowerShell 7+** must be used to download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Thycotic.SecretServer/).

> **Warning** **Windows PowerShell 5.1** TLS error: PowerShell Gallery only supports TLS 1.2 and above, errors noted [here](https://devblogs.microsoft.com/powershell/powershell-gallery-tls-support/#errors-i-might-see) may be observed. You will need to start a new PowerShell session and set TLS to 1.2: `[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12`

## Option 2: Manual Install
## Option 1: Manual Install

You can manually copy the module to a desired PowerShell Modules path, `PSModulePath`.

Expand All @@ -55,21 +39,6 @@ More: [about_PSModulePath](https://docs.microsoft.com/en-us/powershell/module/mi

There are multiple options for downloading the module files:

### PowerShell Gallery

- Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Thycotic.SecretServer/) by running:

```powershell
Save-Module -Name Thycotic.SecretServer -Path C:\temp -AllowPrerelease
```

Copy the `Thycotic.SecretServer` directory to the `PSModules` path of choice.

You can also use the module from the saved path by providing the absolute path to the PSD1 file:

```powershell
Import-Module c:\temp\Thycotic.SecretServer\<version>\Thycotic.SecretServer.psd1
```

### GitHub Release

Expand Down Expand Up @@ -114,3 +83,18 @@ Get detailed information on specific commands:
```powershell
Get-Help Get-TssSecret -Full
```
## Option 2: Install from PowerShell Gallery

*PowerShell Gallery does not contain releases after v60.4*

1. Open a PowerShell prompt

2. Execute the following command:

```powershell
Install-Module -Name Thycotic.SecretServer -Scope CurrentUser
```

> **Warning** **Windows PowerShell 5.1 or PowerShell 7+** must be used to download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Thycotic.SecretServer/).

> **Warning** **Windows PowerShell 5.1** TLS error: PowerShell Gallery only supports TLS 1.2 and above, errors noted [here](https://devblogs.microsoft.com/powershell/powershell-gallery-tls-support/#errors-i-might-see) may be observed. You will need to start a new PowerShell session and set TLS to 1.2: `[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12`