Custom Disclaimers

To show messages to PrivX users upon login:

1. On the Administration→Settings page, click Edit. Set the Disclaimers settings in JSON format, similar to the following:

   JSON

   [
   {
    "id": "terms-and-conditions",
    "timeStamp": "2020-01-01T12:00:00Z",
    "path": "^/auth/login$",
    "title": "Terms and Conditions",
    "text": "Lorem ipsum dolor sit amet.",
    "accept": "I have read and agree to the terms and conditions",
    "mode": "popup",
    "acceptable": true,
    "closeable": false
   }
   ]
   

   You can customize the disclaimer content and visibility with the following parameters:

   • id: Unique identifier to keep track of disclaimer acceptance in case multiple disclaimers are used.

   • timeStamp: The date and time the disclaimer was created or updated.

     When the timeStamp is updated the disclaimer will be treated as new and users will see it again even if they previously accepted the disclaimer.

   • path: Optional regular expression that limits the disclaimer to only portions of the PrivX UI, such as the login page.

   • title: Title for the disclaimer.

   • text: Message shown in the disclaimer.

   • accept: Text for the checkbox that allows users to accept the disclaimer.

   • mode: How the disclaimer looks on the page. Can be ​float​​, ​local​​, or ​popup.

   • ​​acceptable: Allow users to accept and close the disclaimer. Can be ​true​ or ​false​​.

     After a user accepts the disclaimer it will not be displayed on subsequent logins, until users clear browser local storage. Unless ​closeable​ is also set to ​true​​, the user must accept the disclaimer to proceed.

   • closeable: Allow users to close the disclaimer without accepting it. Can be ​true​ or ​false​​.

2. Restart PrivX services to apply the changes:

   Bash

   # systemctl restart privx