# TraceBoard Suite – Installation

Thank you for trying TraceBoard Suite! This package contains everything you need to run the full suite (TraceBoard, TraceDocs, and TraceTest) on your own infrastructure.

## Requirements

- Docker (version 20.10 or later)
- Docker Compose (version 2.0 or later)
- A license file (`traceboard.license`) – download from our website

## Installation Steps

1. **Download the license file** from our website and place it in this folder (the same folder as `docker-compose.yml`).

2. **Copy the environment template**:

   ```bash
   cp .env.example .env
Edit the .env file:

Set a strong password for the database (POSTGRES_PASSWORD)

Generate a secure random string for JWT_SECRET_KEY (see comments in the file for help)

Start the suite:

bash
docker compose up -d
This will pull the container images from our registry and start all services. The first startup may take a few minutes.

Verify the services are running:

bash
docker compose ps
All services should show Up or healthy.

Access URLs
Once the stack is running, access the products at:

TraceBoard – http://localhost/board/

TraceDocs – http://localhost/docs/

TraceTest – http://localhost/test/

(If you're running on a different host, replace localhost with your server's IP or hostname.)

Default Login
Email: admin@traceboard.local

Password: admin

Important: Change the password immediately after your first login.

Upgrading
To upgrade to a newer version:

bash
docker compose pull
docker compose up -d
Troubleshooting
The license is not recognised

Ensure the file is named exactly traceboard.license and is in the same directory as docker-compose.yml.

Check that the file is readable (chmod 644 traceboard.license).

Port 80 is already in use

Change the nginx port mapping in docker-compose.yml, e.g., "8080:80".

Then access the suite at http://localhost:8080/board/, etc.

Database connection errors

Ensure the POSTGRES_PASSWORD matches in the .env file and docker-compose.yml.

Check that the database container is healthy (docker compose ps).

I need to reset the demo data

If you want to reset to a clean state, you can:

Stop the stack (docker compose down).
Remove the database volume: docker volume rm traceboard-suite_pgdata.
Restart: docker compose up -d.
Support
For trial support, contact support@traceboardsuite.com.

We typically respond within one business day.