如何在 Ubuntu 18.04 上部署 Mattermost

Mattermost 是一个企业级即时消息平台,是一个开源的自托管 Slack 替代方案。它是用 Golang 和 React 编写的,可以使用 MySQL 或 PostgreSQL 作为数据库后端。 Mattermost 将您的所有团队沟通集中到一个地方,并提供各种功能,包括文件共享,一对一和群发消息,自定义表情符号,视频通话等。

在本教程中,我们将在 Ubuntu 18.04 服务器上安装 Mattermost ,并将Nginx 配置为 SSL 反向代理。

先决条件

在继续本教程之前,请确保您已满足以下先决条件:

创建 MySQL 数据库

我们将使用 MySQL 作为 Mattermost 的数据库。如果您的服务器上没有安装 MySQL 或 MariaDB ,则可以按照这些说明进行安装。

登录 MySQL shell :

1
mysql -u root

使用以下命令为我们的 Mattermost 安装创建新数据库和用户:

1
CREATE DATABASE mattermost;GRANT ALL ON mattermost.* TO [email protected] IDENTIFIED BY 'P4ssvv0rD';

确保使用的密码比 P4ssvv0rD 更安全 。

创建新的系统用户

创建一个将运行我们的 Mattermost 实例的新用户和组。我们将为用户命名 mattermost

1
sudo useradd -U -M -d /opt/mattermost mattermost

安装 Mattermost 服务器

在撰写本文时, Mattermost 的最新稳定版本是 5.1.0 版。使用以下 curl 命令下载存档:

1
sudo curl -L https://releases.mattermost.com/5.1.0/mattermost-5.1.0-linux-amd64.tar.gz -o /tmp/mattermost.tar.gz

下载完成后,将存档解压缩到 /opt 目录

1
sudo tar zxf /tmp/mattermost.tar.gz -C /opt

创建文件的存储目录:

1
sudo mkdir -p /opt/mattermost/data
更改目录所有权为 mattermost 用户:

1
sudo chown -R mattermost: /opt/mattermost

打开 /opt/mattermost/config/config.json 文件,将数据库驱动程序设置为 mysql 并输入数据库信息:

1
2
3
"SqlSettings": {
"DriverName": "mysql",
"DataSource": "mattermost:[email protected](localhost:3306)/mattermost?charset=utf8mb4,utf8&readTimeout=30s&writeTimeout=30s",

为了确保我们的 Mattermost 实例按预期工作,我们先测试一下 Mattermost 服务器。使用以下命令切换到目录 /opt/mattermost 并启动服务器:

1
2
cd /opt/mattermost
sudo -u mattermost bin/mattermost

如果一切正常,服务器将启动,输出将如下所示:

1
2
3
{"level":"info","ts":1532546921.941638,"caller":"app/server.go:115","msg":"Starting Server..."}
{"level":"info","ts":1532546921.9421031,"caller":"app/server.go:154","msg":"Server is listening on [::]:8065"}
{"level":"info","ts":1532546921.9541554,"caller":"app/web_hub.go:75","msg":"Starting 2 websocket hubs"}

我们现在使用 CTRL+C 停止 Mattermost 服务器并继续执行后续步骤。

创建一个 Systemd 单元

为了将我们的 Mattermost 实例作为服务运行,我们将在 /etc/systemd/system/ 目录中创建一个单元文件 mattermost.service

打开文本编辑器并创建以下文件: /etc/systemd/system/mattermost.service

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[Unit]
Description=Mattermost
After=network.target
After=mysql.service
Requires=mysql.service

[Service]
Type=notify
ExecStart=/opt/mattermost/bin/mattermost
TimeoutStartSec=3600
Restart=always
RestartSec=10
WorkingDirectory=/opt/mattermost
User=mattermost
Group=mattermost
LimitNOFILE=49152

[Install]
WantedBy=mysql.service

让 systemd 重新加载配置,并使用以下命令启动 Mattermost 服务:

1
2
sudo systemctl daemon-reload
sudo systemctl start mattermost

我们现在可以检查服务状态:

1
sudo systemctl status mattermost
1
2
3
4
5
6
7
● mattermost.service - Mattermost
Loaded: loaded (/etc/systemd/system/mattermost.service; disabled; ven
Active: active (running) since Wed 2018-07-25 18:39:05 UTC; 41s ago
Main PID: 3091 (mattermost)
Tasks: 18 (limit: 507)
CGroup: /system.slice/mattermost.service
├─3091 /opt/mattermost/bin/mattermost

如果没有错误,请启用 Mattermost 服务在引导时自动启动:

1
sudo systemctl enable mattermost

使用 Nginx 设置反向代理

如果您按照教程如何在 Ubuntu 18.04 上安装 Nginx 以及教程如何在 Ubuntu 18.04 上使用 Let’s Encrypt 来保护 Nginx,您应该已经安装了 Nginx 并配置了 SSL 证书。

现在我们需要为 Mattermost 实例设置一个新的服务器块。打开文本编辑器并创建以下文件: /etc/nginx/conf.d/example.com.conf

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=mattermost_cache:10m max_size=3g inactive=120m use_temp_path=off;

upstream mattermost_backend {
server 127.0.0.1:8065;
}

server {
listen 80;
server_name example.com www.example.com;

include snippets/letsencrypt.conf;
return 301 https://example.com$request_uri;
}

server {
listen 443 ssl http2;
server_name www.example.com;

ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
ssl_trusted_certificate /etc/letsencrypt/live/example.com/chain.pem;
include snippets/ssl.conf;

return 301 https://example.com$request_uri;
}

server {
listen 443 ssl http2;
server_name example.com;

ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
ssl_trusted_certificate /etc/letsencrypt/live/example.com/chain.pem;
include snippets/ssl.conf;

access_log /var/log/nginx/example.com-access.log;
error_log /var/log/nginx/example.com-error.log;

location ~ /api/v[0-9]+/(users/)?websocket$ {
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
client_max_body_size 50M;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Frame-Options SAMEORIGIN;
proxy_buffers 256 16k;
proxy_buffer_size 16k;
proxy_read_timeout 600s;
proxy_pass http://mattermost_backend;
}

location / {
proxy_http_version 1.1;
client_max_body_size 50M;
proxy_set_header Connection "";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Frame-Options SAMEORIGIN;
proxy_buffers 256 16k;
proxy_buffer_size 16k;
proxy_read_timeout 600s;
proxy_cache mattermost_cache;
proxy_cache_revalidate on;
proxy_cache_min_uses 2;
proxy_cache_use_stale timeout;
proxy_cache_lock on;
proxy_pass http://mattermost_backend;
}
}

重新加载 Nginx 服务以使更改生效:

1
sudo systemctl reload nginx

配置 Mattermost

打开浏览器,键入您的域名,您将被重定向到注册页面。

输入您的电子邮件,选择用户名和密码,然后单击 Create Account 按钮创建您的第一个帐户。

系统中第一个创建的用户将具有管理员权限。

在下一步中,配置向导将要求您创建新团队。

单击 Create a new team 链接,输入您的第一个团队并单击 Next 按钮。

在下一步中,系统会要求您选择新团队的网址:

单击 Finish 按钮,您将被重定向到 Mattermost 仪表板,以管理员身份登录。

通过单击导航面板顶部的用户名打开系统控制台,然后在打开的新菜单中单击该 System Console 链接。

通过转到设置常规→配置来设置站点 URL 。

要启用电子邮件通知,请跳转到通知→电子邮件,更改 Enable Email Notificationsfalsetrue 并输入您的 SMTP 参数。

您可以使用任何流行的交易电子邮件服务,如 SendinBlue , SendGrid , Amazon SES , Mandrill , Mailgun , Mailjet 和 Postmark ,或者您可以按照本教程设置自己的邮件服务器。

最后,我们需要重新启动 Mattermost 服务才能使更改生效:

1
sudo systemctl restart mattermost

结论

您已在 Ubuntu 18.04 服务器上成功安装了 Mattermost ,并将 Nginx 设置为反向代理。您现在可以开始使用 Mattermost 与您的团队协作了。