Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

Latest commit

 

History

History
52 lines (33 loc) · 1.43 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.43 KB

reviewer-reporter

Container for sending reports for libero reviewer

Prerequisites

  • You have a Linux or OSX machine. Windows should be supported via WSL 2 but has not been tested.
  • You have installed a recent version of Docker.
  • You have credentials for sending email via STMP for the specified domain.

Quick Start

Before you can start the app, two configuration files need to be created using the templates in the config directory.

First, the mailheader which is defines the header set for mail sent...

cp ./config/mailheader.template ./mailheader

Then, open the file in your prefered editor and at minimum set a valid value for From.

And second, the configuration for mstmp which is the utility used for sending email.

cp ./config/msmtprc.template ./msmtprc

Then, open the file in your prefered editor and at minimum set valid values for host, from, user and password.

You should then be able to launch the container using the below, setting a valid value for the RECIPIENT environment varible.

RECIPIENT='me@example.com' make

All being well, the target inbox should recieve an empty report.

To generate a full report, set the following environment variables inside the container to properly configure database access.

PGHOST
PGUSER
PGPASSWORD
PGDATABASE
PGPORT

License

Licensed under MIT.