Skip to content

mattermost job from mattermost/6.1.1

Github source: e375e1c or master branch

Properties

mattemrost

ElasticsearchSettings

ConnectionUrl

Url for the elasticsearch server

mattermost

AnalyticsSettings

MaxUsersForStatistics

Sets the maximum number of users on the server before statistics for total posts, total hashtag posts, total file posts, posts per day, and active users with posts per day are disabled.

Default
2500

AnnouncementSettings

AllowBannerDismissal

Allow users to dismiss the banner after they have read the announcement

Default
true
BannerColor

Color of the banner itself

Default
'#f2a93b'
BannerText

Text to display in the announcemnet banner

Default
""
BannerTextColor

Color of the banner text

Default
'#333333'
EnableBanner

Enable the announcement banner

Default
false

ClusterSettings

ClusterName

The cluster to join by name. Only nodes with the same cluster name will join together. This is to support Blue-Green deployments or staging pointing to the same database. The deployment name will be used by default.

GossipPort

port used for gossip protocol

Default
8074
StreamingPort

port used for streaming protocol

Default
8075
UseExperimentalGossip

The server attempts to communicate via the gossip protocol over the gossip port. If false, use the streaming port and streaming protocol. NOTE, this port is used for health status no matter what.

Default
false
UseIpAddress

The cluster attempts to communicate using the IP Address, if false, hostname is used

Default
true

ComplianceSettings

Directory

(E20) Sets the directory where compliance reports are written.

Default
./data/
Enable

(E20) Compliance reporting is enabled in Mattermost. (true|false)

Default
false
EnableDaily

(E20) Mattermost generates a daily compliance report. (true|false)

Default
false

ElasticsearchSettings

AggregatePostsAfterDays

Elasticsearch indexes over the age specified by this setting will be aggregated during the daily scheduled job.

Default
365
EnableIndexing

Enables indexing on elasticsearch

Default
false
EnableSearching

Enables searching with Elasticsearch

Default
false
Password

password for ES access

Default
""
PostIndexReplicas

how many replicas to use for each post index

Default
1
PostIndexShards

how many shards to use for each post index

Default
1
PostsAggregatorJobStartTime

The start time of the daily scheduled aggregator job.

Default
03:00
Sniff

Enables sniffing on the ES server

Default
true
Username

username for ES access

Default
""

EmailSettings

ConnectionSecurity

Email connection Security (“”|PLAIN|TLS|STARTTLS)

Default
""
EmailNotificationContentType

specify the amount of detail sent in email notification contents

Default
full
EnableEmailBatching

Users can select how often to receive email notifications, and multiple notifications within that timeframe will be combined into a single email.

Default
false
EnableSMTPAuth

support SMTP servers requiring no authentication

Default
true
EnableSignInWithEmail

Mattermost allows users to sign in using their email and password. (true|false)

Default
true
EnableSignInWithUsername

Mattermost allows users to sign in using their username and password. This setting is typically only used when email verification is disabled. (true|false)

Default
false
EnableSignUpWithEmail

Allow team creation and account signup using email and password. (true|false)

Default
true
FeedbackEmail

Address displayed on email account used when sending notification emails from Mattermost system.

Default
""
FeedbackName

Name displayed on email account used when sending notification emails from Mattermost system.

Default
""
FeedbackOrganization

Organization name and mailing address displayed in the footer of email notifications from Mattermost

Default
""
InviteSalt

32-character (to be randomly generated via System Console) salt added to signing of email invites.

Default
""
PushNotificationContents

Controlls how much detail is provided in push notifications. (generic|full) Generic only sends User and Channel

Default
generic
PushNotificationServer

Location of Mattermost Push Notification Service (MPNS), which re-sends push notifications from Mattermost to services like Apple Push Notification Service (APNS) and Google Cloud Messaging (GCM).

Default
""
RequireEmailVerification

Require email verification after account creation prior to allowing login. (true|false)

Default
false
SMTPPassword

Obtain this credential from the administrator setting up your email server.

Default
""
SMTPPort

Port of SMTP email server.

Default
""
SMTPServer

Location of SMTP email server.

Default
""
SMTPUsername

Obtain this credential from the administrator setting up your email server.

Default
""
SendEmailNotifications

Enables sending of email notifications.

Default
false
SendPushNotifications

Your Mattermost server sends mobile push notifications to the server specified in PushNotificationServer.

Default
false

FileSettings

AmazonS3AccessKeyId

Obtain this credential from your Amazon AWS administrator.

Default
""
AmazonS3Bucket

Name you selected for your S3 bucket in AWS.

Default
""
AmazonS3Endpoint

Endpoint to use for S3

Default
s3.amazonaws.com
AmazonS3Region

AWS region you selected for creating your S3 bucket.

Default
""
AmazonS3SSE

enable S3 Server Side Encryption for file uploads

Default
true
AmazonS3SSL

Enables only secure Amazon S3 Connections. (true|false)

Default
true
AmazonS3SecretAccessKey

Obtain this credential from your Amazon AWS administrator.

Default
""
AmazonS3SignV2

By default, Mattermost uses Signature V4 to sign API calls to AWS, but under some circumstances, V2 is required. For more information about when to use V2, see http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html

Default
false
AmazonS3Trace

Additional debugging information is included in the system logs. Typically set to false in production.

Default
false
Directory

Directory to which files are written.

Default
/var/vcap/store/mattermost/
DriverName

Storage system where files and image attachments are saved. (local|amazons3)

Default
local
EnableFileAttachments

When false, users cannot upload files and images by attaching them to messages.

Default
true
EnableMobileDownload

When false, disables file downloads on mobile apps. Users can still download files from a mobile web browser.

Default
true
EnableMobileUpload

When false, disables file uploads on mobile apps. All file and image uploads on messages are forbidden across clients and devices, including mobile.

Default
true

Allow users to generate public links to files and images for sharing outside the Mattermost system with a public URL.

Default
true
MaxFileSize

Maximum file size for message attachments entered in megabytes in the System Console UI. Converted to bytes in config.json at 1048576 bytes per megabyte. (Default of 52428800 is 50MB)

Default
5.24288e+07
PublicLinkSalt

32-character salt added to the URL of public links when public links are enabled.

Default
""

JobSettings

RunJobs

enable running jobs on the job server

Default
true
RunScheduler

enable scheduling jobs on the job server

Default
true

LdapSettings

BaseDN

The Base Distinguished Name of the location where Mattermost should start its search for users in the AD/LDAP tree.

Default
""
BindPassword

Password of the user given in Bind Username. This field is required, and anonymous bind is not currently supported.

BindUsername

The username used to perform the AD/LDAP search.

ConnectionSecurity

The type of connection security Mattermost uses to connect to AD/LDAP. (“”|TLS|STARTTLS)

Default
""
EmailAttribute

The attribute in the AD/LDAP server that will be used to populate the email addresses of users in Mattermost.

Default
""
Enable

Mattermost allows login using AD/LDAP or Active Directory. (true|false)

Default
false
FirstNameAttribute

(Optional) The attribute in the AD/LDAP server that will be used to populate the first name of users in Mattermost. When set, users will not be able to edit their First Name, since it is synchronized with the LDAP server. When blank, users can set their own First Name in Account Settings.

Default
""
IdAttribute

The attribute in the AD/LDAP server that will be used as a unique identifier in Mattermost.

Default
""
LastNameAttribute

(Optional) The attribute in the AD/LDAP server that will be used to populate the last name of users in Mattermost. When set, users will not be able to edit their Last Name, since it is synchronized with the LDAP server. When blank, users can set their own Last Name in Account Settings.

Default
""
LdapPort

The port Mattermost will use to connect to the AD/LDAP server.

Default
389
LdapServer

The domain or IP address of the AD/LDAP server.

LoginFieldName

The placeholder text that appears in the login field on the login page. Typically this would be whatever name is used to refer to AD/LDAP credentials in your company, so it is recognizable to your users. Defaults to AD/LDAP Username.

Default
""
MaxPageSize

The maximum number of users the Mattermost server will request from the AD/LDAP server at one time. Use this setting if your AD/LDAP server limits the number of users that can be requested at once. 0 is unlimited.

Default
0
NicknameAttribute

(Optional) The attribute in the AD/LDAP server that will be used to populate the nickname of users in Mattermost. When set, users will not be able to edit their Nickname, since it is synchronized with the LDAP server. When blank, users can set their own Nickname in Account Settings.

Default
""
PositionAttribute

(Optional) The attribute in the AD/LDAP server that will be used to populate the position field in Mattermost (typically used to describe a person’s job title or role at the company). When set, users will not be able to edit their position, since it is synchronized with the LDAP server. When blank, users can set their own Position in Account Settings.

Default
""
QueryTimeout

The timeout value for queries to the AD/LDAP server.

Default
60
SkipCertificateVerification

Skips the certificate verification step for TLS or STARTTLS connections.

Default
false
SyncIntervalMinutes

Set how often Mattermost accounts synchronize attributes with AD/LDAP, in minutes.

Default
60
UserFilter

(Optional) Enter an AD/LDAP Filter to use when searching for user objects.

Default
""
UsernameAttribute

The attribute in the AD/LDAP server that will be used to populate the username field in Mattermost user interface.

Default
""

License

Enterprise Edition license file contents. EE features will not be available unless this is set.

Default
""

LogSettings

ConsoleLevel

Level of detail at which log events are written to the console when EnableConsole = true. (DEBUG|ERROR|INFO)

Default
INFO
EnableConsole

Output log messages to the console based on ConsoleLevel option. The server writes messages to the standard output stream (stdout).

Default
true
EnableDiagnostics

To improve the quality and performance of future Mattermost updates, this option sends error reporting and diagnostic information to Mattermost, Inc. (true|false)

Default
true
EnableFile

Typically set to true in production. When true, logged events are written to the mattermost.log file in the directory specified by the FileLocation setting.

Default
true
EnableWebhookDebugging

Contents of incoming webhooks are printed to log files for debugging. (true|false)

Default
true
FileFormat

Format of log message output.

Default
'[%D %T] [%L] (%S) %M'
FileLevel

Level of detail at which log events are written to log files when EnableFile = true. (true|false)

Default
true
FileLocation

The location of the log files. The path that you set must exist and Mattermost must have write permissions in it.

Default
/var/vcap/sys/log/mattermost/

MetricsSettings

BlockProfileRate

Value that controls the fraction of goroutine blocking events reported in the blocking profile.

Default
0
Enable

Mattermost enables performance monitoring collection and profiling.

Default
false
ListenAddress

The address the Mattermost server will listen on to expose performance metrics.

Default
:8067

NativeAppSettings

Configurable link to download the Android app.

Default
https://about.mattermost.com/mattermost-android-app/

Configurable link to a download page for Mattermost Apps.

Default
https://about.mattermost.com/downloads/

Configurable link to download the iOS app.

Default
https://about.mattermost.com/mattermost-ios-app/

PasswordSettings

Lowercase

At least one required

Default
false
MinimumLength

(E10 and higher) Minimum number of characters required for a valid password. (5-64)

Default
5
Number

At least one required

Default
false
Symbol

At least one required Valid symbols include: !“#$%&‘()*+,-./:;<=>?@[]^_`|~

Default
false
Uppercase

At least one required

Default
false

Plugins

Jira
Enabled

You can configure JIRA webhooks to post message in Mattermost. To help combat phishing attacks, all posts are labelled by a BOT tag.

Default
false
Secret

The secret used to authenticate to Mattermost. Regenerating the secret for the webhook URL endpoint invalidates your existing JIRA integrations.

UserName

Select the username that this integration is attached to.

PrivacySettings

ShowEmailAddress

Show email address of all users. (true|false)

Default
true
ShowFullName

Show full name of all users. (true|false)

Default
true

RateLimitSettings

Enable

APIs are throttled at the rate specified by PerSec.

Default
false
MaxBurst

Maximum number of requests allowed beyond the per second query limit.

Default
100
MemoryStoreSize

Maximum number of user sessions connected to the system as determined by VaryByRemoteAddr and VaryByHeader variables.

Default
10000
PerSec

Throttle API at this number of requests per second if rate limiting is enabled.

Default
10
VaryByHeader

Vary rate limiting by HTTP header field specified (“”|X-Real-IP|X-Forwarded-For|anything you want)

Default
""
VaryByRemoteAddr

Rate limit API access by IP address.

Default
true

ServiceSettings

AllowCorsFrom

Enable HTTP cross-origin requests from specific domains separated by spaces. Type * to allow CORS from any domain or leave it blank to disable it.

Default
""
AllowEditPost

Set the time limit that users have to edit their messages after posting. (always|never|timelimit)

Default
always
AllowedUntrustedInternalConnections

see https://docs.mattermost.com/administration/config-settings.html#allow-untrusted-internal-connections-to

Default
""
ConnectionSecurity

Controls whether MM itself does TLS termination (set to “TLS” to get SSL termination) NOTE: TLSCertFile and TLSKeyFile must be set if this setting is “TLS”

Default
""
EnableAPIv3

Set to false to disable all version 3 endpoints of the REST API. Integrations that rely on API v3 will fail and can then be identified for migration to API v4. API v3 is deprecated and will be removed in the near future. See https://api.mattermost.com for details.

Default
true
EnableChannelViewedMessages

This setting determines whether channel_viewed WebSocket events are sent, which synchronize unread notifications across clients and devices. Disabling the setting in larger deployments may improve server performance.

Default
true
EnableCommands

Slash commands send events to external integrations that send a response back to Mattermost.

Default
false
EnableCustomEmoji

Enables a Custom Emoji option in the Main Menu, where users can go to create customized emoji.

Default
false
EnableDeveloper

Javascript errors are shown in a purple bar at the top of the user interface. Not recommended for use in production.

Default
false
EnableEmojiPicker

Enables an emoji picker that allows users to select emoji to add as reactions or use in messages. Enabling the emoji picker with a large number of custom emoji may slow down performance.

Default
true
EnableIncomingWebhooks

Developers building integrations can create webhook URLs for public channels and private channels.

Default
true
EnableInsecureOutgoingConnections

Outgoing HTTPS requests can accept unverified, self-signed certificates.

Default
false
EnableLinkPreviews

Enables users to display a preview of website content below the message, if available.

Default
false
EnableMultifactorAuthentication

(E10 or higher) When true, users with LDAP and email authentication will be given the option to require a phone-based passcode, in addition to their password-based authentication, to sign-in to the Mattermost server.

Default
false
EnableOAuthServiceProvider

Mattermost acts as an OAuth 2.0 service provider allowing Mattermost to authorize API requests from external applications.

Default
false
EnableOnlyAdminIntegrations

Webhooks and slash commands can only be created, edited and viewed by Team and System Admins, and OAuth 2.0 applications by System Admins.

Default
true
EnableOutgoingWebhooks

Developers building integrations can create webhook tokens for public channels.

Default
true
EnablePostIconOverride

Webhooks, slash commands and other integrations, such as Zapier, will be allowed to change the profile picture they post with.

Default
false
EnablePostUsernameOverride

Webhooks, slash commands, OAuth 2.0 apps, and other integrations such as Zapier, will be allowed to change the username they are posting as. If no username is present, the username for the post is the same as it would be for a setting of False.

Default
false
EnableSecurityFixAlert

Enable System Admins to be notified by email if a relevant security fix alert is announced. (true|false)

Default
true
EnableTesting

/loadtest slash command is enabled to load test accounts and test data.

Default
false
EnableUserAccessTokens

enable personal access tokens for integrations to authenticate against the REST API

Default
false
EnforceMultifactorAuthentication

(E10 or higher) Require MFA for all users.

Default
false
Forward80To443

Determines if traffic on 80 is forwarded to 443. When using a proxy such as NGINX in front of Mattermost this setting is unnecessary and should be set to false.

Default
false
GoogleDeveloperKey

Google API developer key if request rate is too high. See https://docs.mattermost.com/administration/config-settings.html#google-api-key

Default
""
GoroutineHealthThreshold

set a threshold for number of goroutines (-1 is unlimited?? maybe)

Default
-1
ListenAddress

The address and port to which to bind and listen. Specifying “:8065” will bind to all network interfaces. Specifying 127.0.0.1:8065 will only bind to the network interface having that IP address.

Default
:8605
MaximumLoginAttempts

Failed login attempts allowed before a user is locked out and required to reset their password via email.

Default
10
PostEditTimeLimit

How many seconds does a user have to edit a message after posting it.

Default
300
RestrictCustomEmojiCreation

(E10 and greater) Determines who is allowed to create custom emoji (all|admin|system_admin)

Default
all
RestrictPostDelete

Restrict the permission level required to delete messages. Team Admins and System Admins can delete messages only in channels where they are members. Messages can be deleted anytime. (all|team_admin|system_admin)

Default
all
SessionCacheInMinutes

Set the number of minutes to cache a session in memory.

Default
10
SessionLengthMobileInDays

Set the number of days before native mobile sessions expire.

Default
30
SessionLengthSSOInDays

Set the number of days before SSO sessions expire. (gitlab)

Default
30
SessionLengthWebInDays

Set the number of days before web sessions expire and users will need to log in again.

Default
30
SiteURL

The URL, including port number and protocol, that users will use to access Mattermost. This field is required in Mattermost v3.8 and later. REQUIRED to be set

TLSCertFile

The path to the certificate file to use for TLS connection security.

Default
""
TLSKeyFile

The path to the TLS key file to use for TLS connection security.

Default
""
WebserverMode

gzip compression applies to the HTML, CSS, Javascript, and other static content files that make up the Mattermost web client. It is recommended to enable gzip to improve performance unless your environment has specific restrictions, such as a web proxy that distributes gzip files poorly. This setting requires a server restart to take effect. (gzip|Uncompressed|Disabled)

Default
gzip
WebsocketPort

This setting defines the port on which the unsecured WebSocket will listen using the ws protocol.

Default
80
WebsocketSecurePort

This setting defines the port on which the secured WebSocket will listen using the wss protocol.

Default
443

SqlSettings

AtRestEncryptKey

32-character (to be randomly generated via Admin Console) salt available to encrypt and decrypt sensitive fields in database.

Default
""
DataSource

This is the connection string to the master database.

DriverName

Either ‘postgres’ or ‘mysql’

MaxIdleConns

Maximum number of idle connections held open to the database.

Default
10
MaxOpenConns

Maximum number of open connections held open to the database.

Default
10
QueryTimeout

The number of seconds to wait for a response from the database after opening a connection and sending the query. Errors that you see in the UI or in the logs as a result of a query timeout can vary depending on the type of query.

Default
30
Trace

Executing SQL statements are written to the log for development.

Default
false

SupportSettings

Configurable link to an About page describing your organization may provide to end users.

Default
https://about.mattermost.com/default-about/

Configurable link to a Help page your organization may provide to end users.

Default
https://about.mattermost.com/default-help/

Configurable link to Privacy Policy your organization may provide to end users.

Default
https://about.mattermost.com/default-privacy-policy/

Set the link for the support website.

Default
https://about.mattermost.com/default-report-a-problem/
SupportEmail

Set an email for feedback or support requests.

Default
feedback@mattermost.com

Configurable link to Terms of Service your organization may provide to end users.

Default
https://about.mattermost.com/default-terms/

TeamSettings

CustomBrandText

(E10 and greater) Custom text will be shown below custom brand image on left side of server login page.

Default
""
CustomDescriptionText

(E10 and greater) Description of service shown in login screens and UI.

Default
""
EnableCustomBrand

(E10 and greater) Enables custom branding to show a JPG image some custom text on the server login page.

Default
false
EnableOpenServer

Users can sign up to the server from the root page without an invite.

Default
false
EnableTeamCreation

True: Ability to create a new team is enabled for all users. False: Only System Administrators can create teams from the team selection page. The Create A New Team button is hidden in the main menu UI.

Default
true
EnableUserCreation

Ability to create new accounts is enabled via inviting new members or sharing the team invite link. (true|false)

Default
true
EnableXToLeaveChannelsFromLHS

Users can leave Public and Private Channels by clicking the “x” beside the channel name.

Default
false
ExperimentalTownSquareIsReadOnly

Only Administrators can post in Town Square.

Default
false
MaxChannelsPerTeam

Maximum number of channels per team, including both active and deleted channels.

Default
2000
MaxNotificationsPerChannel

Maximum total number of users in a channel before @all, @here, and @channel no longer send notifications to maximize performance.

Default
1000
MaxUsersPerTeam

Maximum number of users per team, including both active and inactive users.

Default
50
RestrictCreationToDomains

Teams and user accounts can only be created by a verified email from this list of comma-separated domains (e.g. “corp.mattermost.com, mattermost.org”).

Default
""
RestrictDirectMessage

Determines who a user can direct message. ‘any’ - anyone on the server, ‘team’ - only users that share at least one team.

Default
any
RestrictPrivateChannelCreation

Restrict the permission level required to create private channels. (all|team_admin|system_admin)

Default
all
RestrictPrivateChannelDeletion

Restrict the permission level required to delete private channels. (all|channel_admin|team_admin|system_admin)

Default
all
RestrictPrivateChannelManageMembers

Set policy on who can add and remove members from private channels. (all|channel_admin|team_admin|system_admin)

Default
all
RestrictPrivateChannelManagement

Restrict the permission level required to rename and set the header or purpose for private channels. (all|channel_admin|team_admin|system_admin)

Default
all
RestrictPublicChannelCreation

Restrict the permission level required to create public channels. (all|team_admin|system_admin)

Default
all
RestrictPublicChannelDeletion

Restrict the permission level required to delete public channels. (all|channel_admin|team_admin|system_admin)

Default
all
RestrictPublicChannelManagement

Restrict the permission level required to rename and set the header or purpose for public channels. (all|channel_admin|team_admin|system_admin)

Default
all
RestrictTeamInvite

(E10 and higher) Set policy on who can invite others to a team using the Send Email Invite, Get Team Invite Link, and Add Members to Team options on the main menu. Options: (all|team_admin|system_admin)

Default
all
SiteName

Site name; it’s not Slack, it is…

Default
Mattermost
TeammateNameDisplay

see https://docs.mattermost.com/administration/config-settings.html#teammate-name-display

Default
username

ThemeSettings

AllowCustomThemes

Enables the Display > Theme > Custom Theme section in Account Settings.

Default
true
AllowedThemes

Select the themes that can be chosen by users when “EnableThemeSelection” is set to true.

Default
'["default", "organization", "mattermostDark", "windows10"]'
DefaultTheme

Set a default theme that applies to all new users on the system.

EnableThemeSelection

Enables the Display > Theme tab in Account Settings so users can select their theme.

Default
true

WebrtcSettings

Enable

Mattermost will allow making one-on-one video calls on Chrome, Firefox and Mattermost Desktop Apps on a server running in SSL mode.

Default
false
GatewayAdminSecret

Enter your admin secret password to access the Gateway Admin URL.

Default
""
GatewayAdminUrl

Mattermost WebRTC uses this URL to obtain valid tokens for each peer to establish the connection. Enter https://:/admin. Make sure you use HTTP or HTTPS in your URL depending on your server configuration.

Default
""
GatewayWebsocketUrl

This is the websocket used to signal and establish communication between the peers. Enter wss://:. Make sure you use WS or WSS in your URL depending on your server configuration.

Default
""
StunURI

Enter your STUN URI as stun::. STUN is a standardized network protocol to allow an end host to assist devices to access its public IP address if it is located behind a NAT.

Default
""
TurnSharedKey

Enter your TURN Server Shared Key. This is used to created dynamic passwords to establish the connection. Each password is valid for a short period of time.

Default
""
TurnURI

Enter your TURN URI as turn::. TURN is a standardized network protocol to allow an end host to assist devices to establish a connection by using a relay public IP address if it is located behind a symmetric NAT.

Default
""
TurnUsername

Enter your TURN Server Username.

Default
""

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/mattermost/ directory (learn more).

  • bin/ctl (from bin/ctl)
  • bin/monit_debugger (from bin/monit_debugger)
  • config/initial-config.json (from config/initial-config.json.erb)
  • config/license (from config/license.erb)
  • data/properties.sh (from data/properties.sh.erb)
  • helpers/ctl_setup.sh (from helpers/ctl_setup.sh)
  • helpers/ctl_utils.sh (from helpers/ctl_utils.sh)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.