Skip to content

Commit 52f0185

Browse files
authored
Added documentation for upgrading SPE.
1 parent 78f2602 commit 52f0185

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

installation/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,33 @@ The SPE module installs like any other for Sitecore. This approach is appropriat
8686

8787
[Download](https://github.com/SitecorePowerShell/Console/releases) the module from the GitHub releases page and install through the _Installation Wizard_.
8888

89+
## Upgrade
90+
91+
We've tried to make upgrading SPE as seamless as possible. The following should provide you with some basic information on what to expect when upgrading.
92+
93+
### From 6.x
94+
95+
You should be able to install directly over the previous installation of 6.0+.
96+
97+
* For Sitecore 10.1 and newer along with Identity Server you should enable the provided configuration _Spe.IdentityServer.config_.
98+
* For Sitecore 10.2 and newer you can leverage the IAR packages. There is still the need for *dacpac* deployments because SPE includes a security user and role.
99+
100+
{% hint style="info" %}
101+
Using packages with the *Items as Resources* (IAR) files will require additional steps to remove database records that correlate with the contents of the _*.dat_ files. Refer to the Sitecore documentation when upgrading for the process to cleanup the databases. [This post](https://www.maartenwillebrands.nl/2022/02/15/sitecore-removing-iar-items-from-the-database/) may be helpful if you wish to take a more precise approach.
102+
{% endhint %}
103+
104+
### From 5.x and older
105+
106+
These versions used a different name for the assemblies and configs. You may find it easier to delete all files originally distributed with SPE before installing a newer version. Here are a few steps to consider:
107+
108+
* Delete all files in the _bin_ and _App_Config/Include_ directories prefixed with *Cognifide*.
109+
* Delete _/sitecore modules/Shell/PowerShell_
110+
* Delete _/sitecore modules/PowerShell_
111+
112+
Reference the original SPE package (if available) to identify if any other files were included.
113+
114+
Sitecore items in the content tree will potentially shuffle around into their new location. Be sure to backup your custom scripts first.
115+
89116
## Troubleshooting
90117

91118
See the troubleshooting section [here](../troubleshooting.md)

0 commit comments

Comments
 (0)