Minimum system requirements

Passwork is not resource-demanding, and the number of required servers depends on the number of active users, the amount of data stored and the system fault tolerance requirements.

See the Technical requirements.

Preparing and receiving the archive

Open PowerShell as "Administrator":

Using Start context menu

1. Right-click on the Start icon in the lower left corner of the screen.
2. Select "Windows PowerShell (Administrator)" from the context menu.

Using Start menu

1. Left-click on the Start icon in the lower left corner of the screen.
2. Write powershell
3. Open PowerShell as "Administrator" with the combination — Ctrl + Shift + Enter

danger

When using Windows Server 2016, you must enable the TLS 1.2 security protocol using the command:

PowerShell

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Get the PassworkModule.zip archive into the current directory:

PowerShell

if (-not (Test-Path "$pwd\PassworkModule.zip")) {
    (New-Object System.Net.WebClient).DownloadFile(
        "https://repos.passwork.pro/repository/powershell/PassworkModule.zip", 
        "$pwd\PassworkModule.zip"
    )
    Write-Host "Module successfully received" -ForegroundColor Green
} else {
    Write-Host "Archive with the module already exists" -ForegroundColor Red
}

info

In case of errors, the archive can be downloaded manually: https://repos.passwork.pro/repository/windows-powershell/PassworkModule.zip

Unzip the PowerShell module:

PowerShell

# Get the location of PowerShell modules
$windowsModulePaths = $env:PSModulePath -split ";" | Where-Object { $_ -like "C:\Windows*" }

# Unzip the PowerShell module to the directory
Expand-Archive `
    -Path "$pwd\PassworkModule.zip" `
    -DestinationPath $windowsModulePaths -Force

# Delete the PassworkModule.zip archive
Remove-Item "$pwd\PassworkModule.zip"

Installation

Start the online installation of Passwork:

PowerShell

Install-Passwork -Method online -v 6

Actions performed by the script

• Checking the operating system version
• Verify and retrieve certificate from client portal
• Checking the available version from the client portal
• Prepare and install MongoDB
• Installation of administration utilities
• Install and configure PHP
• Checking and installing IIS with additional extensions
• Getting and moving Passwork code
• Web server setup with Passwork website creation
• Setting up a Passwork website in conjunction with PHP

Process of executing the installation script

The script will perform a user rights check and perform the download, installation and configuration of the components. If errors occur, the PowerShell shell will display the errors:

During execution, the script requests the API key from the Customer Portal:

Once complete, the address to connect to Passwork via a web browser will be displayed. This is what a successful installation looks like:

Setup wizard

Once installed and configured, Passwork will be available at https://your_servername

warning

By default, Passwork uses a self-signed certificate that is automatically generated during installation, so the first time you open the page you will see a message saying that the browser does not trust the certificate of the site.

Choose language

As the first step, the system will offer to choose the interface language:

System parameters check

The checklist of parameters will show if all necessary components are installed on your server:

Database connection

You must use the default MongoDB address to connect:

Encryption key

Passwork will generate a new key for server encryption. If Passwork is connecting to an existing database, specify the encryption key to be used.

danger

Please use a key generated by Passwork. Using keys generated by third-party tools may cause errors.

License keys

You can download the license keys in your Passwork Customer Portal or request them from your managers.

Setting up your own SSL certificate

By default, Passwork generates a self-signed certificate. After installation, you can switch to using full SSL certificates.

Use your own certificate

• For certificates issued by a trusted issuer.
• For certificates issued by domain certification authorities of your organization.

Open "Server Manager" → "Tools" → "Internet Information Services (IIS) Manager" → "Server Certificates" → and click "Import":

After importing, go to the Passwork website, open "Bindings" and select the imported web certificate for the HTTPS protocol:

Use Let's Encrypt

If there is no domain CA (certificate issued by a trusted CA), but there is a public DNS name of the server, you can configure Let's Encrypt.

Issue a trusted win-acme certificate (Let's Encrypt)

Passwork will be made available over HTTPS using a certificate from Let's Encrypt.

Configure background tasks

Background tasks are tasks that are executed by the scheduler in the background. For example, LDAP synchronisation, loading favicons, and other tasks that are time-consuming, persistent, or resource-demanding.

See a guide on Configuring Windows Task Scheduler