Getting started
Overview
To get a working version of SWF, you need to perform these steps:
- Set up your host server (Windows or Linux)
- Set up a database
- Install the software on the server
- Copy the
config-sample.json, rename itconfig.jsonand update all parameters markedCHANGE~ME - Create a file folder (defaults to
files) - Add your authentication certificate
- Set up SWF as a service provider in PAS
- Set up user search
Supported platforms:
• Windows 64 bit
• Linux 64 bit
The files are available on files.phenixid.se. Use .exe files for Windows and .sh files for Linux.
Setting up the database
Signing Workflow stores metadata about its operations in an SQL database. Current supported version is MS SQL. The database tables will be automatically created when Signing Workflow starts.
Create database
Create a database named digo on your database server. Then, create a database user on the database server. Assign the user DB_OWNER (or equivalent) rights to the workflow database.
Installation on Windows
Hardware
A single instance of Signing Workflow will require a minimum of 2 CPU, 4 GB of RAM and 25 GB of drive space. Setups may differ based on expected load, number of users, number of signatures etc. Please contact Clavister support for guidance.
Note that, depending on the admin rights of the user logged in during installation, "Run as administrator" may be required. If possible this should always be done.
Installation
Unzip the installer and run the included exe file.
Upgrading from SWF 2 to 3
The installer needs a new installation root folder to update properly. The config.json file used in 2.X will work in SWF 3, but it is recommended to update it to adhere to the new standard. See config-template.json to see default configuration.
Upgrade from previous version
The installer will detect whether an upgrade is needed and remove the old application files. The current configuration file (config.json) will not be affected. If custom styling has been done, it will need to be updated to the new standard. For more information, see theme styling.
Starting the application
Locate the Windows service PhenixID Signing Workflow and select Start to start the service. The startup configuration and application version can be found in logs/service-stdout.log. The startup sequence can be verified in the logs/server.log.
Installing on Linux
Hardware
A single instance of the server will require a minimum of 5 GB of drive space and 2 GB of RAM. This setup will be sufficient for installations up to 10 000 users. 4GB of RAM is recommended for installations with 10 000-100 000 users. Please contact Clavister support for larger installations.
Upgrading from SWF 2 to 3
The installer needs a new installation root folder to update properly. The config.json file used in 2.X will work in SWF 3, but it is recommended to update it to adhere to the new standard. See config-template.json to see default configuration.
Installation
Install Zulu-JDK for your Linux version using this binary and documentation: https://www.azul.com/downloads/zulu-community/?version=java-21-lts&os=linux&package=jdk
Uncompress the tar.gz-file to any folder of your need, for example /opt/phenixid/.
Starting the application
Start service: sudo ./start.sh. The startup sequence can be verified in the logs/server.log.