Online installation

Minimum system requirements

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

Please review the full system requirements.

Preparation and obtaining archive

Open PowerShell as "Administrator":

Using the Start Context Menu

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

Using the Start Menu

1. Left-click the Start icon in the lower-left corner of the screen.
2. Type powershell
3. Open PowerShell as "Administrator" by pressing Ctrl + Shift + Enter

danger

When using Windows Server 2016, you need to enable the TLS 1.2 security protocol with the command:

PowerShell

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

Download the PassworkModule.zip archive to 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 obtained" -ForegroundColor Green
} else {
    Write-Host "Module archive already exists" -ForegroundColor Red
}

info

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

Unpack the PowerShell module:

PowerShell

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

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

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

Installation

Run the online installation of Passwork:

PowerShell

Install-Passwork -Method online

Actions performed by the function

• Checking the operating system version
• Checking and obtaining the certificate from the client portal
• Checking the available version from the client portal
• Preparing and installing MongoDB
• Installing administration utilities
• Installing and configuring PHP
• Checking and installing IIS with additional extensions
• Verifying the archive using digital signature
• Obtaining and moving Passwork code
• Configuring the web server with creating the Passwork website
• Configuring the Passwork website with PHP integration

Installation script execution process

The script will check user permissions and perform downloading, installation, and configuration of components. In case of errors, PowerShell will display error messages:

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

Upon completion, it will display the address to connect to Passwork via a web browser. This is what a successful installation looks like:

Installation wizard

After installation and configuration, Passwork will be available at https://your_servername

warning

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

Select language

At the first step, the system will prompt you to select the interface language:

Server settings checklist

The checklist will show whether all components are installed on the server:

Database connection

Change the MongoDB connection to the address — mongodb://localhost:27017

Passwork configuration

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

danger

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

License key

The license key can be downloaded from the Passwork client portal:

SSL certificate configuration

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

Using your own certificate

• For certificates issued by a trusted issuer;
• For certificates issued by your organization's domain certification centers.

Open Server Manager → Tools → 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:

Using Let's Encrypt

If you do not have a domain certification center (a certificate issued by a trusted center), but have a public DNS name for the server, you can set up Trusted Certificate Issuance with win-acme (Let's Encrypt).

Background tasks setup

Background tasks are tasks that run on a scheduler in the background. Example of setting up background tasks.

danger

Background tasks are mandatory for the correct operation of some Passwork features, such as:

• LDAP operations;
• Sending email notifications;
• Favicon uploads;
• Cleaning the session collection in the Passwork database.