Installing, configuring, and managing the HCL VersionVault Express server

The system administrator has the responsibility to install, configure, and manage the VersionVault Express server.


To download the image containing the VersionVault Express server

To download the VersionVault Express image, go to the HCL Software License & Download Portal.
Note: The licenses for VersionVault Express are managed on the HCL Software License & Download Portal by the license administrator.

To import and configure the image to your hypervisor

  1. Import the downloaded OVA file into your hypervisor.
  2. Configure your memory and CPUs, and add a new hard disk.
    Note: The VersionVault Express server comes with one hard disk with the operating system and all of the software pre-installed. You must attach another disk for data storage. The VersionVault Express server cannot boot without a hard disk for storage attached.
  3. Configure your network. If you intend to use port forwarding, you must open up to four ports:
    • 443 for the main user interface and REST APIs
    • 8443 for the setup user interface and REST APIs
    • 8080 if you intend to use external VersionVault clients
    • 22 if you want to SSH in to the server

To start the VersionVault Express server

  1. The first time the server boots up, it checks that there is an attached storage disk.
  2. When prompted, configure the network interfaces. If you configured your network in the hypervisor, you can skip this step and use the default network configuration.
    Note: In headless mode, the server waits for five minutes for you to configure the network and then it proceeds with the default network configuration.

To configure the VersionVault Express server

  1. Open a browser and navigate to the VersionVault Express Appliance Setup user interface, which can be found at https:// hostname:8443. Alternatively, you can use REST APIs to configure your VersionVault Express instance. The swagger documentation can be found at https://hostname:8443/setup/swagger-ui.html.
  2. The first time you use the setup user interface, you are prompted to create an administrator user account and password.

    This account is used to perform the initial configuration and any ongoing system maintenance, including user management. This account can SSH into the server and perform system maintenance, including backup and restore procedures with sudo privileges.

  3. Give this server instance a hostname. You can accept the default port (443) or choose a different one.
    Note: If you do, remember to update any port forwarding or firewalls you might have set up.
  4. If applicable, upload an SSL certificate that is to be used by all three HTTPS servers on the server:
    • the main user interface and REST APIs
    • the setup user interface and REST APIs
    • the server to which your VersionVault clients connect
    Note: Your servers are automatically restarted after the certificate is installed. You must log in again to the administrator interface after the certificate is installed.
  5. Enter your license server and server ID.
    Note: When using a license server hosted on-premises, you might have to install a certificate authority root for it. To upload a certificate authority for your on-premises license server, use the License certificate field on the HCL Licensing panel on the administration UI.
  6. VersionVault Express can be configured either to manage its own users or use an enterprise LDAP server. If you decide to manage your own users, you can configure the VersionVault Express server to use an SMTP server to send invitations to join projects and password reset emails.
    Tip: Where available, select Validate to test the configuration before saving the settings.
  7. If you intend to allow the System Administrator role to SSH into the server, you can optionally set up SSH keys.
  8. Optional: Set up an NTP server and a time zone.
  9. Save your configuration.
  10. Configure some users, either by connecting to an enterprise LDAP server or by creating new users by using the LDAP server self-managed accounts.
  11. When the configuration is all set, click the Save button in the User Configuration section.
  12. Launch VersionVault Express by clicking the Launch VersionVault button.

VersionVault Express is now ready to use.

For more information

In addition to the documentation for VersionVault Express, the following resources are also available: