Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
muratiakos committed Jul 15, 2016
1 parent 36585ac commit 1f613cb
Showing 1 changed file with 22 additions and 21 deletions.
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ PSWebConfig PowerShell module

[![Build status](https://ci.appveyor.com/api/projects/status/4tcovid4e04m1vdx?svg=true)](https://ci.appveyor.com/project/muratiakos/pswebconfig)

PSWebConfig is a PowerShell module that provides an easy way to decrypt and
inspect and test web.config or application configuration files locally or remotely.
PSWebConfig is a PowerShell module that provides an easy way to automatically decrypt,
inspect and test web.config or any .NET based application configuration files both
locally or remotely.

## Installation
PSWebConfig is available via [PsGet][psget], so you can simply install it with the
following command:
PSWebConfig is available via [PowerShellGallery][PowerShellGallery] or [PsGet][psget],
so you can simply install it with the following command:
```powershell
# Install it from PsGet
Install-Module PSWebConfig
# Or install it from this repository
# Or alternatevely you can install it with PsGet from this repository
Install-Module -ModuleUrl https://github.com/muratiakos/PSWebConfig/archive/master.zip
```
Of course you can download and install the module manually too from
Expand All @@ -25,14 +25,25 @@ Import-Module PSWebConfig
```

## Examples
### View and decrypt a web.config
### View and automatically decrypt a web.config
```powershell
# You can pipe any site into Get-PSWebConfig
# You can pipe any site into Get-PSWebConfig to decrypt it automatically
Get-Website * | Get-PSWebConfig -AsText
# You can use -Path attribute to find web.config files
Get-PSWebConfig -Path C:\inetpub\wwwroot\
```
### Test config files
`Test-PSWebConfig` function allows complete tests on all connectionStrings and
Service addresses from a configuration object both on local or remote computers.
```powershell
# Pipe Get-PSWebConfig into Test-PSWebConfig
Get-Website * | Get-PSWebConfig | Test-PSWebConfig
# Or use -Session to test it via remote PSSession
$server1 = New-PSSession 'server1.local.domain'
Get-PSWebConfig -Path C:\inetpub\wwwroot\ -Session $server1 | Test-PSWebConfig
```

### Inspect ConnectionStrings
```powershell
Expand All @@ -44,6 +55,8 @@ Get-PSWebConfig -Path C:\inetpub\wwwroot\ | Get-PSConnectionString -IncludeAppSe
```

### Test ConnectionStrings
`Test-PSConnectionString` cmdlet tries to initiate a SQL connection from a local or
remote computer to test if there are any issue connection to a database.
```powershell
# Pipe Get-PSConnectionString to Test-PSConnectionString
Get-Website * | Get-PSWebConfig | Get-PSConnectionString -Inc | Test-PSConnectionString
Expand All @@ -67,19 +80,6 @@ Get-Website * | Get-PSWebConfig | Get-PSEndpoint
Get-Website * | Get-PSWebConfig | Get-PSUri
```

### Test config files completely
`Test-PSWebConfig` function allows complete tests on all connectionStrings and
Service addresses from a configuration object both on local or remote computers.
```powershell
# Pipe Get-PSWebConfig object into Test-PSWebConfig
Get-Website * | Get-PSWebConfig | Test-PSWebConfig
# Or use -Session to test it via remote PSSession
$server1 = New-PSSession 'server1.local.domain'
Get-PSWebConfig -Path C:\inetpub\wwwroot\ | Test-PSWebConfig -Session $server1
```


Call `help` on any of the PSWebConfig cmdlets for more information and examples.

## Documentation
Expand Down Expand Up @@ -119,4 +119,5 @@ Apache License, Version 2.0 (see [LICENSE][LICENSE])
[license]: LICENSE
[semver]: http://semver.org/
[psget]: http://psget.net/
[PowerShellGallery]: https://www.powershellgallery.com/packages/PSWebConfig
[download]: https://github.com/muratiakos/PSWebConfig/archive/master.zip

0 comments on commit 1f613cb

Please sign in to comment.