Skip to content

Boards AIO - Subdomains

Tip

This deployment type will deploy Huddo Boards on its own domain (e.g. https://boards.company.com).

Note

This setup assumes that you will have 2 subdomains with a shared (wildcard) ssl certificate, both the certificate and key file for these domains need to be accessible to the server and the path filled in under the proxy section.

Setup

DNS

Configure your DNS to point the subdomains to the server running docker compose. For example, for testing you may set in the server's /etc/hosts file:

127.0.0.1 boards.company.com boards-api.company.com

Directory structure

Create a directory for the database and file store

cd /data # or wherever you want to store the data
mkdir huddoboards
cd huddoboards
mkdir ./db ./files

# the mongo & s3 images run with user 1001, set permissions
chown -R 1001 ./db ./files

Download Configuration

  1. Download the following files

    Description File
    Configuration config.zip

    This contains
    - Environment variables (.env)
    - Docker Compose file (docker-compose.yml)
    - NGINX configuration template (nginx.conf.template)
    User authentication Pick the file for your authentication provider:
    - HCL Connections
    - HCL Domino
    - HCL Digital Experience (DX)
    - Microsoft AD

  2. Unzip the config.zip file to the huddoboards directory

  3. copy the user.env file to the huddoboards directory.

Configure

.env

Update the following variables in the .env file:

Variable Example Description
imageTag 2024-08-29 Date of our latest release
appURI boards.company.com URL of Boards UI
apiGateway boards-api.company.com URL of Boards API
smtpHost smtp.example.com Email server
smtpUsername user123 Email server username
smtpPassword passw0rd Email server password
licence Licence key downloaded from Huddo Store
databasePath ./db Path for storage (e.g. fast, backed up etc)
databasePassword dbpassword MongoDB password - it will create the root user on first start
fileStorePath ./files Path for storage (e.g. large, backed up etc)
fileStoreUsername iou1username File Store username - it will be created on first start
fileStorePassword iou1password File Store password - it will be created on first start

user.env

Set all of the variables in the user.env file. Each file contains different variables. For full details of the variables please see the documentation.

Deploy

Run the following command to deploy the application

cd huddoboards
docker compose up -d