pnnl/cb-audit-template repository overview

⁠Audit Template

The Audit Template tool may be used to create a standard building energy audit report and submit to selected jurisdictions to comply with local ordinances. Learn More⁠.

Getting Started: Register for an account, log in, select the Audit Template tab from the home page, add a report, input building audit data and submit. View the Quick Start Guide⁠ for details.

⁠How to use this image

⁠... via docker-compose⁠

version: '3'
 
services:
 
  database:
    image: mcr.microsoft.com/mssql/server:2017-latest
    restart: always
    environment:
      ACCEPT_EULA: 'Y'
      SA_PASSWORD: <password>
      SA_USER: <user>
      MSSQL_PID: Enterprise
      MSSQL_BACKUP_DIR: /var/opt/mssql
      MSSQL_DATA_DIR: /var/opt/mssql
      MSSQL_LOG_DIR: /var/opt/mssql
    # Add if you need to access the database via a DB client
    # ports:
    # - '0.0.0.0:1433:1433'
    volumes:
      - mssql:/var/opt/mssql
 
  rails:
    image: pnnl/cb-audit-template
    user: root
    environment:
      ADMIN_EMAIL: <admin-email>
      ADMIN_PASSWORD: <admin-password>
      DATABASE_HOST: database
      DATABASE_CREDENTIALS: <password>
      SMTP_ADDRESS: <smtp-address>
      SMTP_PORT: <smtp-port>
      SMTP_DOMAIN: <smtp-domain>
      SSL_ENABLED: 'false'
      SECRET_KEY_BASE: <secret-key-base>
    expose:
      - 3000
    volumes:
      - uploads:/home/app/vagrant/simulation
    ports:
      - '0.0.0.0:9001:3000'
    depends_on:
       - 'database'
    links:
      - 'database'
 
volumes:
  mssql: {}
  uploads: {}

Run docker-compose up wait for it to initialize completely, and visit http://localhost:9001⁠.

⁠Environment Variables

⁠Rails

DATABASE_HOST

DATABASE_HOST is always set to database to allow the rails container to send requests to the internal docker network IP assigned to the database container.

DATABASE_CREDENTIALS

This value denotes the database password that will be used to connect to the Microsoft SQL Server instance in the database container. This should match the value of SA_PASSWORD used for the database container.

SMTP_ADDRESS

The rails application utilizes SMTP to send application emails. This value should denote the SMTP service address.

SMTP_PORT

The rails application utilizes SMTP to send application emails. This value should denote the SMTP service address port.

SMTP_DOMAIN

The rails application utilizes SMTP to send application emails. This value should denote the SMTP domain the emails are originating from. By default this is localhost.

SSL_ENABLED

This value is used to force SSL and secure cookies. This value is set to 'false' by default.

SECRET_KEY_BASE

Your secret key is used for verifying the integrity of signed cookies. If you change this key, all old signed cookies will become invalid!

Make sure the secret is at least 30 characters and all random, no regular words or you'll be exposed to dictionary attacks. You can use rake secret to generate a secure secret key.

Example: asjhclasdhjclaskdgalksdjhfalksdhfasuichlasdkflsdfgasdjcasdciud

ADMIN_EMAIL

This variable will be used to create an admin user with the provided email.

ADMIN_PASSWORD

This variable will be used to create an admin user with the provided password.

DOE_MAIL_ADDRESS

This variable will be used to specify the DOE Mailing address to be used by the application.

HELP_DESK_ADDRESS

This variable will be used to specify the Help Desk Mailing address to be used by the application.

EXCEPTION_NOTIFIER_ADDRESS

This variable will be used to specify the Exception Notifier Mailing address to be used by the application.

⁠Database

For documentation regarding environment variables please refer to the "Use With Docker section" of the MSSQL image documentation which can be found here⁠.

⁠Where to Store Data

Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the cb-audit-template images to familiarize themselves with the options available, including:

• Let Docker manage the storage of your data by writing the files to disk on the host system using its own internal volume management. This is the default and is easy and fairly transparent to the user. The downside is that the files may be hard to locate for tools and applications that run directly on the host system, i.e. outside containers.

• Create a data directory on the host system (outside the container) and mount this to a directory visible from inside the container. This places the files in a known location on the host system, and makes it easy for tools and applications on the host system to access the files. The downside is that the user needs to make sure that the directory exists, and that e.g. directory permissions and other security mechanisms on the host system are set up correctly.

The docker-compose script included in this documentation allows docker to manage the storage of data using internal volumes. This can be easily adapted to use data directories on the host machine.