MSUI manual

Managed Service User Interface (MSUI) is an add-on component to Halon. It enables end-users or domain administrators to carry out email-related tasks such as changing settings, trace messages in real time, or look at statistics. It’s ideal for organisations that doesn’t have their own customer portal.

Overview

MSUI allows for extensive customization, including configurable settings and permission levels. It also offers comprehensive branding capabilities with the option of adding custom company logos and color schemes. Advanced customer requests can be implemented with ease thanks to the flexibility and powerful scripting.

There is a demo available (username and password: “demo”) where you can see some examples of commonly implemented settings.

Provided functionality

• Management of domains, based on access control lists

  • Settings (fully customizable)

  • Statistics (fully customizable, such as traffic volumes and spam classification)

  • Monitoring, tracking and management of email history, queue and quarantine

• Management of users

  • Settings (fully customizable)

  • Monitoring, tracking and management of email history, queue and quarantine

  • Optionally with external authentication sources such as LDAP

  • Optionally with 2-factor authentication

• Common settings

  • DKIM key management

  • Block/allow lists

  • Rate limits

  • Spam settings

  • File type and document fingerprint settings

• Audit log for tracking changes

• Delegation of specific permissions to users

• Language and translation support

• Branding; logotype, naming and color theme

• API for programmatically working with users and permissions

This manual references other resources as well, such as:

• Script language reference

• Knowledge base

Table of contents

• 1. Installation
  • 1.1. Requirements
  • 1.2. Setup
    • 1.2.1. Ubuntu
    • 1.2.2. RHEL
    • 1.2.3. Initial setup
  • 1.3. Upgrade
    • 1.3.1. Downgrade
• 2. Configuration
  • 2.1. Minimal configuration
    • 2.1.1. Listener configuration
    • 2.1.2. Database configuration
    • 2.1.3. Basic authentication
  • 2.2. Authentication methods
    • 2.2.1. Local users and database example
    • 2.2.2. Forwarded header example
    • 2.2.3. LDAP example
  • 2.3. Additional settings
    • 2.3.1. Server directives
    • 2.3.2. Database directives
    • 2.3.3. App directives
    • 2.3.4. Frontend directives
    • 2.3.5. Backend directives
    • 2.3.6. Authentication directives
    • 2.3.7. User authentication directives
    • 2.3.8. Access token authentication directives
    • 2.3.9. LDAP authentication directives
    • 2.3.10. Forwarded header authentication directives
    • 2.3.11. Database password directives
    • 2.3.12. Session directives
    • 2.3.13. Rate limit directives
    • 2.3.14. Audit log directives
• 3. History logging configuration
  • 3.1. Minimal configuration
    • 3.1.1. Elasticsearch configuration
    • 3.1.2. MTA configuration
  • 3.2. Additional settings
    • 3.2.1. Elasticsearch directives
    • 3.2.2. MTA directives
    • 3.2.3. Digest reports directives
• 4. Configuration export
  • 4.1. Configure MSUI
  • 4.2. Configuration export directives
• 5. Web administration
  • 5.1. Creating new settings
  • 5.2. Digest reports
  • 5.3. Input validation
  • 5.4. Branding
• 6. Permissions
  • 6.1. User roles
  • 6.2. Inheritance
  • 6.3. Global settings
  • 6.4. Two-factor authentication
• 7. Integration
  • 7.1. MSUI Client
    • 7.1.1. Ubuntu
    • 7.1.2. RHEL
  • 7.2. Settings in MSUI
    • 7.2.1. msui-config.yaml
• 8. API

• Changelog