OVERVIEW

Support Packet Generation tool will allow users to grab information about their Mattermost instance to provide to the support team to save the trouble for support asking manually for this information. It is in the hopes of increasing productivity and making the process of getting information from a customer faster and easier.

...

SPECIFICATIONS

High-level Architecture

Describe

Permissions

Any new permissions or changes to permissions

Schema

List schema changes

REST API

Server OS:

In golang, we can use runtime.GOOS to get the operating system which the server is running on.

...

{
   "active":[
      
   ],
   "inactive":[
      {
         "id":"antivirus",
         "name":"Antivirus",
         "description":"Antivirus plugin for scanning uploaded files.",
         "version":"0.1.2",
         "server":{
            "executables":{
               "linux-amd64":"server/dist/plugin-linux-amd64",
               "darwin-amd64":"server/dist/plugin-darwin-amd64",
               "windows-amd64":"server/dist/plugin-windows-amd64.exe"
            },
            "executable":""
         },
         "settings_schema":{
            "header":"Antivirus plugin for scanning uploaded files to Mattermost, uses ClamAV to scan files. See [documentation here](https://github.com/mattermost/mattermost-plugin-antivirus)",
            "footer":"",
            "settings":[
               {
                  "key":"ClamavHostPort",
                  "display_name":"ClamAV - Host and Port",
                  "type":"text",
                  "help_text":"The hostname and port to connect to clamd",
                  "placeholder":"localhost:3310",
                  "default":"localhost:3310"
               },
               {
                  "key":"ScanTimeoutSeconds",
                  "display_name":"Scan Timeout (seconds)",
                  "type":"number",
                  "help_text":"How long the virus scan can take before giving up.",
                  "placeholder":"10",
                  "default":10
               }
            ]
         }
      }
   ]
}

LDAP Vendor:

LDAP Version:

Elastic Search Server Version:

In elasticsearch.go in enterprise, in the Start() function, we are already getting the version and storing it in a variable called version. It would be a matter of storing that in a new field called fullVersion and writing a function which returns that since currently version field is only storing the major version instead of the full version.

Elastic Search Plugins:

Is not currently implemented but a matter of implementing (following how the other elastic search endpoints are) https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html

Log File:

if *s.Config().LogSettings.EnableFile {
   		logFile := utils.GetLogFileLocation(*s.Config().LogSettings.FileLocation)
		file, err := os.Open(logFile)
		// Write that file into the zip the user will download
}

Active Config Settings:

A matter of calling c.App.GetSanitizedConfig() as it already seems to scrub out all confidential information

Designs can be found at https://www.figma.com/file/ck3EfTynW7nrRlkJGCYKRL/Support-Packet-Request .

Regarding debug level, check to see if their out logs to file is enabled and if the file log levels is set to debug. If not, then let’s show the message in the design to encourage them to enable it and set it to debug and try to recreate their issue to provide us with the most amount of information.

CLI

List CLI additions

Configuration

Webapp only

Mobile and Webapp

Performance

Will there be performance degradation or impact?

Plugins

CREDITS

Thanks to