Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-23589

Serve Drive configuration from the config folder instead of accessing it directly through nuxeo.war

    XMLWordPrintable

    Details

    • Release Notes Summary:
      Drive configuration can be served by the Nuxeo Platform server-side
    • Tags:
    • Backlog priority:
      600
    • Impact type:
      API change
    • Upgrade notes:
      Hide

      A new endpoint $NUXEO_URL/api/v1/drive/configuration allows to fetch the global configuration for Nuxeo Drive in the JSON format.

      The configuration file nuxeo-drive-config.json is defined in the drive template provided by the nuxeo-drive package and its default values are:

      {
  "delay": 30,
  "ignored_prefixes": [".", "icon\r", "thumbs.db", "desktop.ini", "~$"],
  "ignored_suffixes": [".bak", ".crdownload", ".lock", ".nxpart", ".part", ".partial", ".swp", ".tmp", "~", ".dwl", ".dwl2"],
  "ignored_files": ["^atmp\\d+$"],
  "log_level_file": "DEBUG",
  "timeout": 30,
  "handshake_timeout": 60,
  "beta_channel": false,
  "update_check_delay": 3600,
  "ui": "web"
}
      Show
      A new endpoint $NUXEO_URL/api/v1/drive/configuration allows to fetch the global configuration for Nuxeo Drive in the JSON format. The configuration file nuxeo-drive-config.json is defined in the drive  template provided by the nuxeo-drive package and its default values are: { "delay" : 30, "ignored_prefixes" : [ "." , "icon\r" , "thumbs.db" , "desktop.ini" , "~$" ], "ignored_suffixes" : [ ".bak" , ".crdownload" , ".lock" , ".nxpart" , ".part" , ".partial" , ".swp" , ".tmp" , "~" , ".dwl" , ".dwl2" ], "ignored_files" : [ "^atmp\\d+$" ], "log_level_file" : "DEBUG" , "timeout" : 30, "handshake_timeout" : 60, "beta_channel" : false , "update_check_delay" : 3600, "ui" : "web" }
    • Sprint:
      nxfit 9.3.10, nxfit 9.10.1
    • Story Points:
      5

      Description

      Previously, since NXP-22946, the Drive global configuration file located in the "drive" template of the nuxeo-drive package was directly copied to nxserver/nuxeo.war to be available as a static resource through $NUXEO_URL/nuxeo/drive/config.json.

      This was an issue because the nuxeo.war folder is built dynamically and can be rebuilt completely during the preprocessing phase or by the hot reload for instance, which could remove the whole nuxeo.war/drive folder, especially in 7.10 under Windows. As a consequence, after installing the nuxeo-drive package (1.5.6) on Nuxeo 7.10 with the latest hotfixes and starting the server, the configuration file was not available.

      Let's copy the configuration file to the server's configuration folder nxserver/config and serve it through a dedicated endpoint $NUXEO_URL/api/v1/drive/configuration.
      ------------------------------------------------------------
      Note:

      • In 9.10 we've added a REST API endpoint in the new nuxeo-drive-rest-api bundle
      • In 8.10-HF20 and 7.10-HF35, to avoid adding a new bundle in the HF or nuxeo-drive package, we've mapped a plain servlet to /api/v1/drive/configuration.

        Attachments

          Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. NXP-23828 Random Read timed out in NuxeoDriveObjectTest

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. NXP-23917 Fix API doc when Drive is not installed on the server

          • Critical - Crashes, loss of data, severe memory leak.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. NXP-22946 Allow configuring Drive globally from server

          • Major - Major loss of function.
          • Resolved

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 4 days, 1 hour
                  4d 1h