Uploaded image for project: 'Zanata'
  1. ZNTA-1557

Zanata should abort deployment if required system properties missing

    Details

    • Tested Version/s:
      None
    • Sprint:
      16.24

      Description

      A number of Zanata's system properties are required for proper operation. Without them, authentication may not work, or important files may be stored in the JBoss process's current directory (whatever that happens to be).

      Most of these properties are described in the documentation, but it would be better to catch their absence early in the boot process (I suggest using io.undertow.servlet.ServletExtension). That way, third party code like JavaMelody might not get a chance to write files to the wrong directory.

      The main properties (as of Zanata 4.0):

      REQUIRED DIRECTORY PATHS

      Abort if absent - the first two also need to be documented:

      • hibernate.search.default.indexBase
      • javamelody.storage-directory
      • zanata.file.directory

      REQUIRED AUTH POLICY

      Exactly one of these is required, except you may combine internal and openid - otherwise abort deployment.

      • zanata.security.authpolicy.jaas
      • zanata.security.authpolicy.kerberos
      • zanata.security.authpolicy.internal
      • zanata.security.authpolicy.openid

      OPTIONAL PROPERTIES

      Ignore these; just listed for completeness.

      • zanata.security.adminusers
      • zanata.email.defaultfromaddress

      OBSOLETE DIRECTORY PATH

      (along with ehcache.xml and any cache files in this directory)
      For Zanata 4.0, we should consider aborting the deployment if this is present.

      • ehcache.disk.store.dir

        Attachments

          Issue links

            Activity

              People

              • Assignee:
                pahuang Patrick Huang
                Reporter:
                sflanigan Sean Flanigan
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: