plugin.json

{
    "id": "com.mattermost.cloud",
    "name": "Mattermost Private Cloud",
    "description": "This plugin allows spinning up and down Mattermost installations using Mattermost Private Cloud.",
    "version": "0.1.36",
    "min_server_version": "8.1.0",
    "server": {
        "executables": {
            "linux-amd64": "server/dist/plugin-linux-amd64",
            "darwin-amd64": "server/dist/plugin-darwin-amd64",
            "darwin-arm64": "server/dist/plugin-darwin-arm64"
        }
    },
    "webapp": {
        "bundle_path": "webapp/dist/main.js"
    },
    "settings_schema": {
        "header": "",
        "footer": "",
        "settings": [
            {
                "key": "ProvisioningServerURL",
                "display_name": "Provisioning Server URL",
                "type": "text",
                "help_text": "The URL of the Mattermost Private Cloud provisioning server."
            },
            {
                "key": "ProvisioningServerAuthToken",
                "display_name": "Provisioning Server Auth Token",
                "type": "text",
                "help_text": "The token required for authenticating with the AWS API Gateway."
            },
            {
                "key": "ProvisioningServerClientID",
                "display_name": "Provisioning Server Client ID",
                "type": "text",
                "help_text": "The client ID used to authenticate with the provisioning server."
            },
            {
                "key": "ProvisioningServerClientSecret",
                "display_name": "Provisioning Server Client Secret",
                "type": "text",
                "help_text": "The client secret used to authenticate with the provisioning server"
            },
            {
                "key": "ProvisioningServerTokenEndpoint",
                "display_name": "Provisioning Server Token Endpoint",
                "type": "text",
                "help_text": "The token endpoint used to authenticate with the provisioning server."
            },
            {
                "key": "ProvisioningServerWebhookSecret",
                "display_name": "Webhook secret sent by the provisioning server",
                "type": "text",
                "help_text": "The secret used to verify that webhooks are coming from the provisioning server. Plugin will read from the X-MM-Cloud-Plugin-Auth HTTP header"
            },
            {
                "key": "InstallationDNS",
                "display_name": "Installation DNS",
                "type": "text",
                "help_text": "The domain name to create the installations with. e.g. test.mattermost.cloud"
            },
            {
                "key": "AllowedEmailDomain",
                "display_name": "Allowed Email Domain",
                "type": "text",
                "help_text": "(Optional) When set, users must have an email ending in this domain to use the cloud slash command."
            },
            {
                "key": "DeletionLockInstallationsAllowedPerPerson",
                "display_name": "Deletion Lock Installations Per Person",
                "type": "text",
                "help_text": "(Optional) When set, this value represents the maximum number of workspaces each user is allowed to lock from deletion",
                "default": "1"
            },
            {
                "key": "E10License",
                "display_name": "Mattermost E10 License",
                "type": "longtext",
                "help_text": "The contents of a E10 license."
            },
            {
                "key": "E20License",
                "display_name": "Mattermost E20 License",
                "type": "longtext",
                "help_text": "The contents of a E20 license."
            },
            {
                "key": "EnterpriseLicense",
                "display_name": "Mattermost Enterprise License",
                "type": "longtext",
                "help_text": "The contents of an Enterpise license."
            },
            {
                "key": "ProfessionalLicense",
                "display_name": "Mattermost Professional License",
                "type": "longtext",
                "help_text": "The contents of a Professional license."
            },
            {
                "key": "GroupID",
                "display_name": "Group ID",
                "type": "text",
                "help_text": "(Optional) When set, all new installations created by the plugin are created within this group."
            },
            {
                "key": "EmailSettings",
                "display_name": "Email Settings",
                "type": "longtext",
                "help_text": "The JSON EmailSettings section for Mattermost. Only used when Group ID is not set."
            },
            {
                "key": "ClusterWebhookAlertsEnable",
                "display_name": "Enable Cluster Webhook Alerts",
                "type": "bool",
                "help_text": "Enable or disable the plugin from sending alerts to the channel defined below when cluster webhooks are received from the provisioner.",
                "default": false
            },
            {
                "key": "ClusterWebhookAlertsChannelID",
                "display_name": "Cluster Webhook Alerts Channel ID",
                "type": "text",
                "help_text": "The channel ID to send cluster webhook alerts to when enabled. This channel must exist for alerts to be sent."
            },
            {
                "key": "InstallationWebhookAlertsEnable",
                "display_name": "Enable Installation Webhook Alerts",
                "type": "bool",
                "help_text": "Enable or disable the plugin from sending alerts to the channel defined below when installation webhooks are received from the provisioner.",
                "default": false
            },
            {
                "key": "InstallationWebhookAlertsChannelID",
                "display_name": "Installation Webhook Alerts Channel ID",
                "type": "text",
                "help_text": "The channel ID to send installation webhook alerts to when enabled. This channel must exist for alerts to be sent."
            },
            {
                "key": "DefaultDatabase",
                "display_name": "Default Database",
                "type": "dropdown",
                "help_text": "The default database to use for new installations.",
                "default": "aws-multitenant-rds-postgres-pgbouncer",
                "options": [
                    {
                        "display_name": "Perseus",
                        "value": "perseus"
                    },
                    {
                        "display_name": "PgBouncer",
                        "value": "aws-multitenant-rds-postgres-pgbouncer"
                    },
                    {
                        "display_name": "MySQL Operator",
                        "value": "mysql-operator"
                    }
                ]
            },
            {
                "key": "DefaultFilestore",
                "display_name": "Default Filestore",
                "type": "dropdown",
                "help_text": "The default filestore to use for new installations.",
                "default": "bifrost",
                "options": [
                    {
                        "display_name": "Bifrost",
                        "value": "bifrost"
                    },
                    {
                        "display_name": "AWS Multitenant S3",
                        "value": "aws-multitenant-s3"
                    },
                    {
                        "display_name": "AWS S3",
                        "value": "aws-s3"
                    },
                    {
                        "display_name": "Minio Operator",
                        "value": "minio-operator"
                    }
                ]
            },
            {
                "key": "EnableCommandAutocompletion",
                "display_name": "Enable Command Autocompletion",
                "type": "bool",
                "help_text": "Enable or disable autocompletion for the /cloud slash command",
                "default": true
            }
        ]
    }
}