...

...

...

...

...

...

...

...

...

...

OVERVIEW

GOALS

...

-

...

-

...

Support Packget 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.

Still in the process of deciding whether it should be a plugin or code implemented within the code.

Who should be able to download? System Admins? Anyone? Who?!?

GOALS

1. - Make it easier for support to gather the information they need

SCOPE

In:

Out:

BACKGROUND READING

TERMINOLOGY

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.

Although not mentioned in the MVP, we can use runtime.GOARCH to get the architecture of the server. (ex. amd64)

Database Type:

In the store, we have a function available called DriverName() which returns either mysql or postgres. This is what we use elsewhere to determine if our database is either mysql or postgres.

(*SqlChannelStore).DriverName()

Database Version:

In the database, we have a table called Systems which we can query to get the version.

SELECT systems WHERE name == Version

List plugins installed (including versions):

We can do a

     response, err := c.App.GetPlugins()     
     if err != nil {         
      c.Err = err         
      return     
     }

which when we convert to JSON will return something like this

{
   "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:

CLI

List CLI additions

Configuration

Webapp only

Mobile and Webapp

Performance

Will there be performance degradation or impact?

Plugins

CREDITS

Thanks to