1. Preliminary Steps

  1. Repository Synchronization

    • In your Bitbucket, perform a fork sync from the shared config_default repository into the client-specific repository.
    • As a result, storage.conf will be updated with paths for Postbox files, containers.conf will be updated with the container version, and commands.conf will be updated with the relevant deployment code.

  2. Updating Local Configurations

    • After resolving any merge conflicts that arise during the sync, run a git pull on the client-specific config on the DMS host to retrieve the latest version.
    • Make sure the deployment script is also up to date by running update_scripts.sh.

  3. Verifying DMS Availability

    • Before deploying Postbox, ensure that your DMS instance is running normally and responding as expected.

  4. Enabling Postbox in DMS

    • In your dms.conf file, add the line POSTBOX_ENABLED=true (placed strictly above the HTTPS parameter). This tells the DMS to load and enable the Postbox functionality.

2. Deployment Process

  1. Deployment Command

    • Deploy Postbox using the postbox parameter. For example:
      deploy.sh -vvv postbox
    • Postbox will work with or without HTTPS, depending on the general DMS configuration.

  2. Configuring the PAT_DMS_SETTINGS Table

    • Designating a “Receiving” Case
      • In Patricia, you need a case (for example, VA1DE00) to which all incoming emails will be saved.
      • In PAT_DMS_SETTINGS, set this case number using postbox.incoming.mail.case.
    • Start Date
      • In postbox.initial.date, specify the date in yyyy-mm-dd format from which Postbox will start processing emails.
      • Any emails received before this date will be ignored, preventing older emails from being reprocessed.
    • List of Tracked Addresses
      • In postbox.email.listener.addresses, specify the email addresses for Postbox to track (via the “To” and “Cc” fields).
      • Emails sent to other addresses in the same domain are not shown in Postbox to maintain privacy.
    • List of Users with Access to Postbox
      • In postbox.users, define a JSON array of strings (user logins) that can access Postbox. For example:
        ["user1", "user2", "admin"]
    • Email Lifetime
      • In postbox.incoming.mail.lifetime, specify the number of days (default is 20) after which an email will no longer be displayed in Postbox.
      • If an email is older than the defined number of days, it will not appear to users.
    • Term List URL
      • In postbox.termlist.url, set the path to the term list report (for example, reports/1234).
      • Postbox can use this URL to open the term list report in Patricia if needed.

3. Accessing Postbox

  • HTTPS deployment:
    https://<dmsserver>/postbox
  • Non-HTTPS deployment:
    http://<dmsserver>:9083/postbox

4. Additional Notes

  • Compatibility: Postbox is available starting from DMS version 1.10.0. The version of Postbox must match the version of the Nuxeo container.
  • Licensing: A valid DMS license, including Postbox rights, is required and can be requested from the client contact in Patrix or Serviva.
  • No labels