2.2 Project Structure and File Organization

The top-level files and folders are categorized and described below.

General information

• LICENSE: Eclipse Public License 2.0
• README.md: Project description and introduction

Documentations

• docs: documentations and diagram on network protocol and API calls

Terraform

• main.tf: Terraform configuration file that defines the resources to be created in the Amazon Web Services cloud platform
• output.tf: Specifies the output data values for printing or reporting when updating resource state using terraform apply.
• provider.tf: Contains the terraform block to import required provider plugins and their configurations.
• variables.tf: Contains the variable declarations used in the resource blocks.

Vagrant

• Vagrantfile: Descriptor file for Vagrant to setup main and stepup site
• provision: shell scripts to configure the guest virtual machines, primarily to install and configure Docker. They are available for CentOS 9 Stream, Ubuntu 22.04 (Jammy Jellyfish) and Alpine Linux 3.20.

Docker

• docker-compose.yaml: Docker Compose file for building and starting Docker containers

Docker images for container

• db: MariaDB Docker image
• file: SAMBA on Alpine Linux Docker image
• mail: Apache James Docker image
• toc: TOC controller Docker image. See also: toc-backend and toc-frontend
• web: Apache HTTPD Docker image

Development and testing tools

• dns: dnsmasq on Alpine Linux Docker image as a local authoritative DNS server to provide MX records to IMAP clients for mail server
• maradns: configuration files for MaraDNS server to simulate multiple servers/services on localhost without Docker during development

Source codes

• toc-backend: RESTful service for TOC controller and servers. Includes the Swagger/OpenAPI definition.
• toc-frontend: React web application built on Material Design for Bootstrap (MDB).