Release candidate
...
Standard installation
Linux

Online installation

24min

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.

If the server has 2-4 GB of RAM, we recommend enabling a SWAP file, as the build reserves memory for tmpfs and opcache.

System update

DEB-based

Shell


RPM-based

Shell


Docker installation

Download and install Docker v.18.06.0 or higher. See the official installation guide by Docker.

Install and enable the Docker Compose plugin. See the official installation guide by Docker.

We recommend using a non-Snap version of Docker

Passwork installation

To install Passwork, you need to download and run the script that will install all the necessary components.

Create a directory and open it:

Shell


Copy the installation script:

Shell


Authenticity check

Check the hash of the passwork_compose_install.sh file to verify its authenticity:

Shell


You should see the message passwork_compose_install.sh: OK.

User rights verification and script execution

If you are installing not as root, make sure that the user is a member of the docker group.

Confirm that using the following method:

Shell


You can add a user to the docker group like this:

Shell


Grant execution rights to the script and run it:

Shell


The script uses apt or dnf, as well as curl. If a proxy server is used in your network, you need to add environment variables: export http_proxy=http://proxy.example.com:8080 export https_proxy=http://proxy.example.com:8080

Process of executing the installation script

The script will check the rights of the current user, as well as the versions of the necessary components. In case of errors, the script will create an error log with the install_log_date.log format

Document image


During the execution, the certificate number will be requested from the Customer portal:

Document image


After the script execution is completed

The script will automatically execute docker ps. Please check the list of running containers. If the containers were not started, please check the installation output and log. Example of a correct output:

Document image


Setup wizard

After building and running the containers, Passwork will be available at the following link: https://your_servername

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 site's certificate is not trusted.

Choose language

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

Document image


Server configuration checklist

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

Document image


Database connection

You must use the default MongoDB address to connect:

Document image


Passwork configuration

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

Do not enter a key that was generated outside of Passwork. Passwork uses special secure algorithms to generate new keys in required formats. Using keys generated by third-party tools may result in errors.

Document image


License key

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

Document image


Setting up your own SSL certificate

By default, Passwork will generate a self-signed certificate during install. When the installation is complete you will be able to start using proper SSL certificates.

Use your own certificate

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

Rename your SSL certificate or certification chain and place it in ./conf/ssl

  • privkey.pem — private key
  • fullchain.pem — certificate\certification chain

Use Let's Encrypt

You can configure Let's Encrypt if you don't have a certificate authority (certificate issued by a trusted center), but you have a public DNS name for the server.

Edit the .env file by changing and adding the following parameters:

Text


Save the changes and start the container:

Shell


Check the container logs to see if the certificate was issued:

Shell


Example of certificate issuing process:

Document image


Recreate containers to update data using the new certificates:

Shell


As a result, Passwork will be available via the HTTPS protocol using a certificate from Let's Encrypt.

Updated 10 Mar 2025
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?