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 see the technical requirements if your server has 2 4 gb of ram, we recommend enabling the enabling swap file on linux docid 4bakilpetuhwcwxyd6vjf file system update deb based sudo apt get update rpm based sudo yum update 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 mkdir your directory cd your directory copy the installation script wget https //repos passwork pro/repository/docker/passwork compose install sh authenticity check check the hash of the passwork compose install sh file to verify its authenticity echo "8d0d73444689b1e9a83ed07e999a48c93087eae98ef3d5e41e7d8d889306bfc5 passwork compose install sh" | sha256sum check 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 id $user | grep docker you can add a user to the docker group like this sudo usermod a g docker $user grant execution rights to the script and run it chmod +x passwork compose install sh /passwork compose install sh 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 actions performed by the script checking installed docker checking docker version (above 18 06 0) checking running docker checking user for membership in the docker group or having sudo rights checking if docker compose plugin is installed and enabled checking the system for belonging to deb or rpm distribution installing additional utilities for proper operation of scripts curl , unzip , and jq requesting input of passwork client certificate checking the certificate for compliance with the format checking the validity of the certificate downloading and unpacking the archive with docker compose build files checking the environment variables file and adding the certificate number executing the passwork code update script executing docker compose up d 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 during the execution, the certificate number will be requested from the customer portal 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 before configuring a web server with ssl termination enabled, familiarize yourself with the ssl termination docid\ aqgt0an6 xcudu ahpjwq 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 server configuration checklist 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 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 license key you can download the license keys in your passwork customer portal 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 use letsencrypt=true letsencrypt reg email=mail\@example com domain=example com compose profiles="local notify,mongo,certbot” save the changes and start the container docker compose up d certbot check the container logs to see if the certificate was issued docker compose logs certbot example of certificate issuing process recreate containers to update data using the new certificates docker compose up d force recreate nginx certbot as a result, passwork will be available via the https protocol using a certificate from let's encrypt