plugin.json

{
    "id": "com.github.manland.mattermost-plugin-gitlab",
    "name": "GitLab",
    "description": "GitLab plugin for Mattermost.",
    "homepage_url": "https://github.com/mattermost/mattermost-plugin-gitlab",
    "support_url": "https://github.com/mattermost/mattermost-plugin-gitlab/issues",
    "icon_path": "assets/icon.svg",
    "min_server_version": "7.1.0",
    "server": {
        "executables": {
            "darwin-amd64": "server/dist/plugin-darwin-amd64",
            "darwin-arm64": "server/dist/plugin-darwin-arm64",
            "linux-amd64": "server/dist/plugin-linux-amd64",
            "linux-arm64": "server/dist/plugin-linux-arm64",
            "windows-amd64": "server/dist/plugin-windows-amd64.exe"
        },
        "executable": ""
    },
    "webapp": {
        "bundle_path": "webapp/dist/main.js"
    },
    "settings_schema": {
        "header": "To set up the GitLab plugin, you need to register a GitLab OAuth app here https://gitlab.com/-/profile/applications.",
        "footer": "To report an issue, make a suggestion, or submit a contribution, [check the repository](https://github.com/mattermost/mattermost-plugin-gitlab).",
        "settings": [
            {
                "key": "UsePreregisteredApplication",
                "display_name": "Use Preregistered OAuth Application:",
                "type": "bool",
                "help_text": "When true, instructs the plugin to use the preregistered GitLab OAuth application - application registration steps can be skipped. Requires [Chimera Proxy](https://github.com/mattermost/chimera) URL to be configured for the server. Can only be used with official gitlab.com. **This setting is intended to be used with Mattermost Cloud instances only.**",
                "placeholder": "",
                "default": false
            },
            {
                "key": "GitlabURL",
                "display_name": "GitLab URL:",
                "type": "text",
                "help_text": "The base URL for using the plugin with a GitLab installation. Examples: https://gitlab.com or https://gitlab.example.com.",
                "placeholder": "https://gitlab.com",
                "default": "https://gitlab.com"
            },
            {
                "key": "GitlabOAuthClientID",
                "display_name": "GitLab OAuth Client ID:",
                "type": "text",
                "help_text": "The client ID for the OAuth app registered with GitLab.",
                "placeholder": "",
                "default": null
            },
            {
                "key": "GitlabOAuthClientSecret",
                "display_name": "GitLab OAuth Client Secret:",
                "type": "text",
                "help_text": "The client secret for the OAuth app registered with GitLab.",
                "placeholder": "",
                "default": null
            },
            {
                "key": "WebhookSecret",
                "display_name": "Webhook Secret:",
                "type": "generated",
                "help_text": "The webhook secret set in GitLab.",
                "placeholder": "",
                "default": null
            },
            {
                "key": "EncryptionKey",
                "display_name": "At Rest Encryption Key:",
                "type": "generated",
                "help_text": "The AES encryption key used to encrypt stored access tokens.",
                "placeholder": "",
                "default": null
            },
            {
                "key": "GitlabGroup",
                "display_name": "GitLab Group:",
                "type": "text",
                "help_text": "(Optional) Set to lock the plugin to a single GitLab group.",
                "placeholder": "groupName",
                "default": null
            },
            {
                "key": "EnablePrivateRepo",
                "display_name": "Enable Private Repositories:",
                "type": "bool",
                "help_text": "(Optional) Allow the plugin to work with private repositories for subscriptions.",
                "placeholder": "",
                "default": null
            },
            {
                "key": "EnableChildPipelineNotifications",
                "display_name": "Enable Child Pipelines Notification:",
                "type": "bool",
                "help_text": "Allow the plugin to post notfication for child pipelines when the pipeline subscription is created in a channel.",
                "placeholder": "",
                "default": true
            },
            {
                "key": "EnableCodePreview",
                "display_name": "Enable Code Previews:",
                "type": "dropdown",
                "help_text": "Allow the plugin to expand permalinks to GitLab files with an actual preview of the linked file.",
                "default": "public",
                "options": [
                    {
                        "display_name": "Enable for public projects",
                        "value": "public"
                    },
                    {
                        "display_name": "Enable for public and private projects. This might leak confidential code into public channels",
                        "value": "privateAndPublic"
                    },
                    {
                        "display_name": "Disable",
                        "value": "disable"
                    }
                ]
            }
        ]
    }
}