Introduction

The TeamDrive Registration Server Virtual Appliance offers a pre-installed and ready-to-run TeamDrive Registration Server suitable for deployment in a virtualized environment like VMWare.

This document will guide you through the deployment and initial installation of the Virtual Appliance and the configuration of the TeamDrive Registration Server.

This Installation Guide outlines the deployment of a single node installation, where all required components are located on the same OS instance. Please consult the TeamDrive Registration Server Administration Guide for recommendations about scalability and/or high availability.

Requirements

Required Skills

When installing the TeamDrive Registration Server, we assume that you have basic knowledge of:

  • VMware: importing and deploying virtual machines, configuring virtual networking and storage (when installing the TeamDrive Server components in a virtual environment or when using a pre-installed Virtual Appliance)
  • Linux system administration:
    • Adding/configuring software packages
    • Editing configurations files with a text editor (e.g. vi or nano)
    • Starting/stopping services, enabling them at system bootup time
    • Creating Linux users
    • Assigning file ownerships and privileges
    • Creating and mounting file systems
    • Setting up environment variables
  • Apache HTTP Server: installation and configuration, adding and enabling modules, modifying configuration files
  • MySQL Database: installation and configuration, administration/maintenance, using the MySQL command line client, basic SQL
  • MTA configuration: installing and configuring a local MTA like the Postfix mail server
  • Basic knowledge of application server technology

Network Requirements

The system must have IP connectivity, using a fixed IP address and a resolvable fully qualified domain name. The Registration Server itself needs to be able to properly resolve host names, too.

../_images/TeamDriveHosting-Networking-Overview1.png

TeamDrive Network Overview

If the Registration Server is located behind a firewall, please ensure that it is reachable via HTTPS (TCP port 443) by the TeamDrive App (Client). HTTPS access is also required for accessing the web-based Administration Console and can be further restricted to certain client (browser) IP addresses.

The Registration Server needs to be able to establish outgoing HTTPS connections (TCP port 443) to https://tdns.teamdrive.net/ and its Master Registration Server (https://reg.teamdrive.net by default), either directly or via an existing HTTPS proxy server.

For more details about TDNS, see chapter TeamDrive Name Server (TDNS).

For the initial registration and the exchange of cryptographic keys, the Host Server must be able to contact the Registration Server via HTTPS (TCP port 443). After the registration and activation, the Registration Server will also make calls to the Host Server API (e.g. to create new Space Depots or to query for existing Spaces for a particular user). For this purpose, the TeamDrive Registration Server must be able to establish outgoing HTTPS connections to the TeamDrive Hosting Service.

If you use External Authentication for Authenticating users, the Registration Server needs to be able to establish outgoing HTTPS connections to the host providing the external Authentication Service.

Hardware Requirements

The TeamDrive Registration Server Virtual Appliance is delivered in the form of a virtual machine image. Its main technical specifications are:

  • Supported platforms: VMWare vSphere 4, 5, 6, 7 or 8 (VMWare Workstation or Oracle VM VirtualBox can be used for testing purposes)
  • Minimum VM Memory: 4 GB
  • vCPUs: 2
  • HDD: 100GB
  • Guest OS: CentOS Stream 9 (64-bit)

Main Software components

The TeamDrive Registration Server comprises the following components and modules:

  • Apache Web Server 2.4
  • MySQL server (8.0)
  • PHP 8.3
  • Yvva Runtime Environment version 1.5.9