Installation Checklist

The legacy Vault backend is planned for deprecation in future releases. If you're still on Vault, see Migrating from Vault to Git to switch to the recommended Git backend.

New Vault Teams server

• Create the Teams server in the portal. See: Add servers

Download the required files

• Download the Teams server license file and certificate bundle from the Servers tab.

• Download the installers (Teams server and IDA Pro) from the Download center.

Installation

• Start the Teams server installer and follow the steps on the screen.

• Copy the Teams server license, the certificate and the private key previously downloaded to the installation directory.

• Change the license, certificate and private key ownership and access mode:

>cd /opt/hexvault
>cp .../path/to/hexvault.crt .
>cp .../path/to/hexvault.key .
>cp .../path/to/teams_server_*.hexlic .
>chown hexvault:hexvault hexvault.crt hexvault.key teams_server_*.hexlic
>chmod 640 hexvault.crt hexvault.key teams_server_*.hexlic

• Create the initial database:

>sudo -u hexvault ./vault_server --config-file hexvault.conf \
                                 --vault-dir ./files \
                                 --certchain-file hexvault.crt \
                                 --privkey-file hexvault.key \
                                 --recreate-schema
>2022-04-14 14:30:28 Vault Server v1.0 Hex-Rays (c) 2022-2024
>2022-04-14 14:30:28 Database initialized; exiting.

• Test the server:

>sudo -u hexvault ./vault_server --config-file hexvault.conf \
                                 --certchain-file hexvault.crt \
                                 --privkey-file hexvault.key \
                                 --license-file teams_server_<LID>.hexlic \
                                 --vault-dir ./files
>2022-04-14 14:35:47 Vault Server v1.0 Hex-Rays (c) 2022-2024
>2022-04-14 14:35:47 Using a license with 5 seats
>2022-04-14 14:35:47 Listening on 0.0.0.0:65433...

• Ctrl + C to stop the server.

• Start the service: systemctl start hexvault

• Check that the service is active: systemctl status hexvault

In case of startup problems, check the troubleshooting section.

Creating the administrator

• Create the administrator using hv tool. The hv is bundled with IDA Pro. The first user to log in to the Teams server will have administrator privileges.

./hv -h<host>:<port> -u<user> -p<password>

At that point you can create users, groups, ...