Uniform Siphon - Installation

This guide covers how to install and configure the Uniform Siphon toolkit on your Windows machine.

Before you begin, ensure you have:

  1. Windows operating system
  2. Direct HTTP access to Sitecore instance
    • The Windows workstation needs direct HTTP(s) access to the source Sitecore instance
    • HTTP proxy is supported when configured via Windows' Settings → Proxy → Manual proxy setup
  3. The Siphon distribution package (siphon-download-{ver}.zip or siphon-{ver}.zip)

How to get Siphon

Siphon is licensed and provided separately from your Uniform Platform subscription. You can request the tool via a support ticket or your Uniform account representative. In your request, provide details about your migration project, including the source CMS and timelines.

Extract the contents of the siphon-download-{ver}.zip file to C:\siphon.

Recommeneded directory

It is advised to use recommended C:\siphon\ directory to make use of these guides easier.

# After extraction, your directory should contain: C:\siphon\ ├── {ver}\ | ├── Siphon.Download.exe | ├── playwright.ps1 | └── ... other files └── siphon.ps1

Windows may block executable files downloaded from the internet. You need to unblock them before use:

  1. Navigate to C:\siphon in File Explorer
  2. Locate Siphon.Download.exe
  3. Right-click on Siphon.Download.exe and select Properties
  4. If you see a security message at the bottom stating "This file came from another computer and might be blocked to help protect this computer", check the Unblock checkbox
  5. Click Apply, then OK

Alternatively, you can use PowerShell (as Administrator) to unblock all files in the directory:

PS> Get-ChildItem -Path "C:\siphon" -Recurse | Unblock-File

Install Playwright to enable downloading presentation (not required for basic content-only migration):

PS> cd C:\siphon\{ver}\ ; .\playwright.ps1 install

Review the command output in order to verify the installation was successful.

Add C:\siphon to your machine's PATH environment variable:

  1. Open System Properties (press Win + R, type sysdm.cpl, and press Enter)
  2. Click the Advanced tab
  3. Click Environment Variables
  4. Under System variables, find and select Path, then click Edit
  5. Click New and add C:\siphon
  6. Click OK to save all dialogs

Alternatively, you can use PowerShell with administrator privileges:

PS> [Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\siphon", "Machine")

After modifying the PATH, restart your terminal or command prompt for changes to take effect.

Open a new terminal window and verify the installation:

PS> siphon

or

PS> C:\siphon\siphon.ps1

If the command outputs help information, the installation was successful.

Last modified
Next
Data download