@halon/web-ui v5.1.0

Halon Web UI

A web UI for managing the componentized package of the Halon MTA.

Requirements

• Node >= 10.13.0 (LTS)

Deployment

General information

To deploy the web UI in production we recommend using a node process manager such as PM2 or forever as well as an init system like systemd or upstart.

The executable file is called halon-web-ui and it will be automatically symlinked when installing the package.

Environment variables

The following environment variables should be set:

• NODE_ENV=production
• HALON_WEB_UI_SETTINGS=/tmp/settings.json
• HALON_WEB_UI_PORT=3000

To enable TLS, set the following environment variables:

• HALON_WEB_UI_CERT=/etc/ssl/certs/public.pem
• HALON_WEB_UI_KEY=/etc/ssl/private/private.key

Settings file

Below is an example on what the settings.json file should look like.

{
  "hosts": [{
    "id": "smtp1.example.com",
    "ssh2": {
      // https://github.com/mscdex/ssh2
      ...
    },
    "sequelize": {
      // http://docs.sequelizejs.com/class/lib/sequelize.js~Sequelize.html#instance-constructor-constructor
      ...
    }
  }],
  "users": [{
    "username": "admin@example.com",
    "password": "..." // Password should be hashed using bcrypt
  }]
}