Self Hosted Client Setup

See Clarity Self Hosted for details on the requirements for the virtual machine and database.

Clarity Security Appliance

Clarity will provide you with an .ova (let us know if you need a special format) for creating the Virtual Machine within your infrastructure.  This will be preconfigured with the following options based on your requirements:

• SSH Enabled or Disabled

• Local or AWS Cloudwatch logs

• Email through AWS or ready to configure with local SMTP

Client Setup Script

Once you receive the virtual disk and spin up the virtual machine, we will need to configure the virtual machine to connect to the database.  Either connect to the console via your hypervisor console or SSH into the machine if you requested SSH be enabled out of the box.

Networking

You will need networking working before you can run the client setup script.  If you have DHCP enabled on the virtual machine network, this should happen automatically.

If you need to used a static IP address, you will need to manually configure the network settings in the virtual machine.

The Client Setup Script handles the following:

1. Change Root Password (Required)

2. Configure Database Connection (Required)

3. Configure local App URL (Required, Ex: https://self-host.claritysecurity.io)

4. Configure SMTP (Optional, you can also opt for Clarity to handle email distribution)

Next we will run the client setup script in which you will need to provide following values, Clarity will provide you with the randomly generated password for your appliance.

Navigate to /var/www/html and execute the clientsetup.sh script.  It will prompt you for the information below.

Passwords

DB_PASSWORD and MAIL_PASSWORD cannot contain the character “#”.

Reset the local Admin password

Once again you will need to log into (SSH preferred) into your Clarity appliance to change the password for the admin account for the UI.

Below is the sequence of commands to overwrite the existing password for your webUI admin user.

cd /var/www/html/
php artisan tinker

#(once in tinker)

$user = User::find(1);
$user->password = Hash::make('YOUR_PASSWORD_HERE');
$user->save();
exit

Below is an example of a successful password reset using the commands above:

Special Notes

Your clarity appliance has 2 local password that you will want to store securely:

• Root Account: The root account of the Virtual Machine appliance

  • User: root, Password: Secure password of your choosing

• Local Admin: The Local Admin account for your Clarity webUI

  • User: admin@claritysecurity.io, Password: Secure password of your choosing

Need help?