Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=3.0.0 <5.0.0
- , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'liger1978-mattermost', '1.12.1'
Learn more about managing modules with a PuppetfileDocumentation
mattermost
Table of Contents
- Overview
- Module Changes
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with mattermost
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module installs and configures Mattermost, to provide secure, private cloud messaging for teams and enterprises. More information is available at: https://about.mattermost.com.
The name for this deployment solution in the context of the
Mattermost branding guidelines
is Puppet module for Mattermost by Richard Grainger
.
Following automated deployment, the following steps are required to make your system production-ready:
Please see https://docs.mattermost.com for the official Mattermost documentation.
Module Changes
From module version 1.7.0, the default value of conf
(the default
Mattermost configuration file location) has changed to /etc/mattermost.conf
.
This is to allow configuration changes made using the web GUI to be preserved
during Mattermost application upgrades.
Module Description
The Mattermost module does the following:
- Installs the Mattermost server from a release archive on the web, or an alternative download location within your firewall.
- Installs and configures a daemon (service) for Mattermost in the format native to your operating system.
- Configures Mattermost according to settings you provide.
Setup
What mattermost affects
- Downloads and installs Mattermost server
(defaults to
/opt/mattermost-${version}
). - Creates a friendly symbolic link to the installation directory (defaults to
/opt/mattermost
). - Creates a configuration file (defaults to
/etc/mattermost.json
) based on the vendor-provided configuration file and adds user-supplied options. - Creates a Mattermost daemon (service) using your operating system's native service provider.
Beginning with mattermost
If you have a suitable database installed for Mattermost server to use as a backend, this is the minimum you need to get Mattermost server working:
class { 'mattermost':
override_options => {
'SqlSettings' => {
'DriverName' => 'postgres',
'DataSource' => "postgres://db_user:db_pass@db_host:db_port/mattermost?sslmode=disable&connect_timeout=10",
},
},
}
This will install a Mattermost server listening on the default TCP port (currently 8065).
Here is an example of Mattermost using PostgreSQL as a database and NGINX as a reverse proxy, all running on the same system (requires puppetlabs/postgresql and puppet/nginx):
class { 'postgresql::globals':
manage_package_repo => true,
version => '9.4',
} ->
class { 'postgresql::server':
ipv4acls => ['host all all 127.0.0.1/32 md5'],
}
postgresql::server::db { 'mattermost':
user => 'mattermost',
password => postgresql_password('mattermost', 'mattermost'),
}
postgresql::server::database_grant { 'mattermost':
privilege => 'ALL',
db => 'mattermost',
role => 'mattermost',
} ->
class { 'mattermost':
override_options => {
'SqlSettings' => {
'DriverName' => 'postgres',
'DataSource' => "postgres://mattermost:mattermost@127.0.0.1:5432/mattermost?sslmode=disable&connect_timeout=10",
},
},
}
class { 'nginx': }
nginx::resource::upstream { 'mattermost':
members => [ 'localhost:8065' ],
}
nginx::resource::server { 'mattermost':
server_name => [ 'myserver.mydomain' ],
proxy => 'http://mattermost',
location_cfg_append => {
'proxy_http_version' => '1.1',
'proxy_set_header Upgrade' => '$http_upgrade',
'proxy_set_header Connection' => '"upgrade"',
},
}
With the above code, you should be able to access the Mattermost application at
http://myserver.mydomain
(or whatever resolvable DNS domain you chose) via
the NGINX reverse proxy listening on port 80.
Usage
Use override_options
to change Mattermost's default settings:
class { 'mattermost':
override_options => {
'ServiceSettings' => {
'ListenAddress' => ":80",
},
'TeamSettings' => {
'SiteName' => 'BigCorp Collaboration',
},
'SqlSettings' => {
'DriverName' => 'postgres',
'DataSource' => "postgres://mattermost:mattermost@127.0.0.1:5432/mattermost?sslmode=disable&connect_timeout=10",
},
'FileSettings' => {
'Directory' => '/var/mattermost',
},
}
}
Store file data, such as file uploads, in a separate directory (recommended):
class { 'mattermost':
override_options => {
'FileSettings' => {
'Directory' => '/var/mattermost',
},
},
}
Install a specific version:
class { 'mattermost':
version => '4.3.2',
version => '4.4.2',
}
Install Enterprise edition:
class { 'mattermost':
edition => 'enterprise',
}
Install a release candidate:
class { 'mattermost':
version => '4.0.4-rc1',
}
Download from an internal server:
class { 'mattermost':
version => '4.4.2',
full_url => 'http://intranet.bigcorp.com/packages/mattermost.tar.gz',
}
Upgrading Mattermost
The module can elegantly upgrade your Mattermost installation. To upgrade, just specify the new version when it has been released, for example:
class { 'mattermost':
version => '4.4.2',
}
On the next Puppet run, the new version will be downloaded and installed; the friendly symbolic link will be changed to point at the new installation directory and the service will be refreshed.
Note 1: The Mattermost application supports certain upgrade paths only. Please see the upgrade guide
Note 2: Always backup your data before upgrades.
Note 3: For a seamless upgrade you should store your file data outside of the Mattermost installation directory so that your uploaded files are still accessible after each upgrade. For example:
class { 'mattermost':
override_options => {
'FileSettings' => {
'Directory' => '/var/mattermost',
},
},
}
Security Updates
We highly recommend users subscribe to the Mattermost security updates email list. When notified of a security update, the maintainers of this deployment solution will make an effort to update to the secure version within 10 days.
Reference
Classes
Public classes
mattermost
: Main class, includes all other classes
Private classes
mattermost::install
: Installs the Mattermost server from a web archive and optionally installs a daemon (service) for Mattermost in the format native to your operating system.mattermost::config
: Configures Mattermost according to provided settings.mattermost::service
: Manages the Mattermost daemon.
Parameters
mattermost
base_url
The base URL to download the Mattermost server release archive. Defaults to
https://releases.mattermost.com
.
edition
The edition of Mattermost server to install. Defaults to team
. Valid values
are team
and enterprise
.
version
The version of Mattermost server to install. Defaults to 4.4.2
.
file_name
The filename of the remote Mattermost server release archive.
Defaults to mattermost-team-${version}-linux-amd64.tar.gz
(for Team edition)
or mattermost-${version}-linux-amd64.tar.gz
(for Enterprise edition),
so with the default version
, the default value will be
mattermost-team-4.4.2-linux-amd64.tar.gz
.
full_url
The full URL of the Mattermost server release archive. Defaults to
${base_url}/${version}/${filename}
, so with the default base_url
, edition
,
version
and file_name
, this will be:
https://releases.mattermost.com/4.4.2/mattermost-team-4.4.2-linux-amd64.tar.gz
.
Please note: If you set full_url
you should also set version
to match the version of Mattermost server you are installing.
dir
The directory to install Mattermost server on your system. Defaults to
/opt/mattermost-${version}
.
symlink
The path of the friendly symbolic link to the versioned Mattermost installation
directory. Defaults to /opt/mattermost
.
conf
The path to Mattermost's config file. Defaults to /etc/mattermost.conf
.
create_user
Should the module create an unprivileged system account that will be used to run
Mattermost server? Defaults to true
.
create_group
Should the module create an unprivileged system group that will be used to run
Mattermost server? Defaults to true
.
user
The name of the unprivileged system account that will be used to run
Mattermost server. Defaults to mattermost
.
group
The name of the unprivileged system group that will be used to run
Mattermost server. Defaults to mattermost
.
uid
The uid of the unprivileged system account that will be used to run
Mattermost server. Defaults to 1500
.
gid
The gid of the unprivileged system group that will be used to run
Mattermost server. Defaults to 1500
.
override_options
A hash containing overrides to the default settings contained in Mattermost's
config file.
Defaults to {}
(empty hash).
Note 1: You should at least specify SqlSettings
, e.g.:
class { 'mattermost':
override_options => {
'SqlSettings' => {
'DriverName' => 'postgres',
'DataSource' => "postgres://db_user:db_pass@db_host:db_port/mattermost?sslmode=disable&connect_timeout=10",
},
},
}
Note 2: To purge existing settings from the configuration file, use the
purge_conf
parameter.
override_options['FileSettings']['Directory']
An element of the override_options
hash that specifies the Mattermost data
directory. Setting this element will result in the directory being created with
the correct permissions if it does not already exist (unless
manage_data_dir
is false
).
An absolute path must be specified. Example:
class { 'mattermost':
override_options => {
'FileSettings' => {
'Directory' => '/var/mattermost',
},
},
}
purge_conf
Should the module purge existing settings from Mattermost configuration file?
Defaults to false
.
manage_data_dir
Should the module ensure Mattermost's data directory exists and has the correct
permissions? This parameter only applies if
override_options['FileSettings']['Directory']
is set. Defaults to true
.
depend_service
The local service (i.e. database service) that Mattermost server needs to start
when it is installed on the same server as the database backend. Defaults to
''
(empty string).
install_service
Should the module install a daemon for Mattermost server appropriate to your
operating system? Defaults to true
.
manage_service
Should the module manage the installed Mattermost server daemon
(ensure => 'running'
and enable => true
)? Defaults to true
.
service_template
ERB
(Embedded RuBy) template to use for the service definition file. Defaults
to a bundled template suitable for the server's operating system.
service_path
The target path for the service definition file. Defaults to the standard path for the server's operating system.
service_provider
The Puppet service provider to use for service management. Defaults to an appropriate value for the server's operating system.
Limitations
This module has been tested with Puppet 3 and 4.
This module has been tested on:
- Red Hat Enterprise Linux 6, 7
- CentOS 6, 7
- Oracle Linux 6, 7
- Scientific Linux 6, 7
- Debian 7, 8
- Ubuntu 12.04, 12.10, 13.04, 13.10, 14.04, 14.10, 16.04, 16.10
- SLES 12
Note: According to the Mattermost software requirements documentation, the following platforms are offically supported by Mattermost:
Ubuntu 14.04, Debian Jessie, CentOS 6.6+, CentOS 7.1+, Red Hat Enterprise Linux 6.6+, RedHat Enterprise Linux 7.1+, Oracle Linux 6.6+, Oracle Linux 7.1+.
Development
Please send pull requests. For maintenance and contributor info, see the maintainer guide.
2017-11-23 Carlos Panato ctadeu@gmail.com - 1.12.1
- Default to Mattermost 4.4.2
2017-11-17 Carlos Panato ctadeu@gmail.com - 1.12.0
- Default to Mattermost 4.4.1
2017-11-13 Carlos Panato ctadeu@gmail.com - 1.11.2
- Default to Mattermost 4.3.2
2017-10-19 Carlos Panato ctadeu@gmail.com - 1.11.1
- Default to Mattermost 4.3.1
2017-10-15 Richard Grainger grainger@gmail.com - 1.11.0
- Default to Mattermost 4.3.0
2017-10-02 Richard Grainger grainger@gmail.com - 1.10.1
- Publish module with puppet-blacksmith and GitLab-CI
2017-09-27 Carlos Panato ctadeu@gmail.com - 1.10.0
- Default to Mattermost 4.2.0
2017-08-30 Carlos Panato ctadeu@gmail.com - 1.9.0
- Default to Mattermost 4.1.0
2017-05-29 Richard Grainger grainger@gmail.com - 1.8.0
- Default to Mattermost 3.9.0
2017-04-24 Richard Grainger grainger@gmail.com - 1.7.2
- Support new binary argument format
- Improve Debian sysv init script.
- Default to Mattermost 3.8.2
2017-03-30 Richard Grainger grainger@gmail.com - 1.7.1
- Fixed README
2017-03-30 Richard Grainger grainger@gmail.com - 1.7.0
- Change default conf file location to aide Mattermost upgrades
- Default to Mattermost 3.7.3
2017-03-06 Richard Grainger grainger@gmail.com - 1.6.1
- Add .pmtignore [#25]
- Update Maintainer Guide link in README
2017-03-06 Richard Grainger grainger@gmail.com - 1.6.0
- Fix README with regards to complete PostgreSQL/NGINX example [#21]
- Add Vagrant dev environment [#22]
- Fix
mattermost::service_mode
unknown variable warnings [#23] - Default to Mattermost 3.6.2 [#24]
- Add
limit nofile 50000 50000
to upstart service template - Add
LimitNOFILE=49152
to systemd service template - Add suggested text to README from Mattermost Deployment Solution Programs
- Add Maintainer Guide
2016-11-28 Richard Grainger grainger@gmail.com - 1.5.1
- Make service_provider a class parameter
- Improve documentation
2016-11-25 Richard Grainger grainger@gmail.com - 1.5.0
- Support Mattermost Enterprise edition
- Default to Mattermost 3.5.1
2016-09-19 Richard Grainger grainger@gmail.com - 1.4.1
- Support Mattermost 3.4.0
- Move source code to gitlab.com
2016-07-18 Richard Grainger grainger@gmail.com - 1.4.0
- Support Mattermost 3.2.0
2016-07-11 Richard Grainger grainger@gmail.com - 1.3.1
- Fix issue with SMTPPort setting in config.json
2016-06-16 Richard Grainger grainger@gmail.com - 1.3.0
- Support Mattermost 3.1.0
- Support Ubuntu 16.04 (Xenial)
2016-05-22 Richard Grainger grainger@gmail.com - 1.2.3
- Support Mattermost 3.0.2
2016-04-21 Richard Grainger grainger@gmail.com - 1.2.2
- Support Mattermost 2.2.0
2016-03-26 Richard Grainger grainger@gmail.com - 1.2.1
- Remove redundant $conf pointing to missing param (gguillotte - Puppet Labs)
- Clean up line endings in templates (gguillotte - Puppet Labs)
- Several README edits (gguillotte - Puppet Labs)
2016-03-21 Richard Grainger grainger@gmail.com - 1.2.0
- Support Mattermost 2.1.0
- New default download location
- Drop support for Debian 6 (Squeeze)
2016-01-25 Richard Grainger grainger@gmail.com - 1.1.0
- Support Mattermost 1.4.0
- Allow external config.json file with conf parameter
- Add purge_conf parameter
- Make systemd service more robust
- Better support for Puppet 3
2016-01-14 Richard Grainger grainger@gmail.com - 1.0.5
- Refresh service when config changes
2016-01-13 Richard Grainger grainger@gmail.com - 1.0.4
- Manage Mattermost data directory in non-default location
- Allow smooth upgrades
2016-01-11 Richard Grainger grainger@gmail.com - 1.0.3
- Remove conf variable from params.pp
- Improve README
2016-01-09 Richard Grainger grainger@gmail.com - 1.0.2
- Correct README
- Correct metadata
2016-01-09 Richard Grainger grainger@gmail.com - 1.0.1
- Fix metadata
2016-01-09 Richard Grainger grainger@gmail.com - 1.0.0
- Initial 1.0.0 release
Dependencies
- puppetlabs/stdlib (>= 4.2.0 <5.0.0)
- nanliu/staging (>= 1.0.0 <2.0.0)
Copyright 2016 Richard Grainger Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.