mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
b5f007d35e
* docs: resolve cross-file anchor mismatches from RST-to-MDX migration
The Sphinx-to-Docusaurus migration converted `:ref:`/`{ref}` links using
naive text-slugification, so anchors that pointed to headings in a
different file (e.g. release-summary tables linking into their
respective changelog pages) were emitted as same-page fragments and
silently resolved to nothing.
Built a label registry from the original Sphinx `.. _label:` / `(label)=`
targets to recover the true source file for each cross-reference, then
rewrote the affected links to point at the correct file + heading
anchor. Fixes 282 broken cross-file anchors, primarily in the mobile/
desktop/server release-summary pages, plus assorted same-page anchor
mismatches caught by re-auditing after the prior admonition/anchor fix.
* docs: manually resolve remaining anchor mismatches after cross-file audit
Hand-verified fixes for anchors that fuzzy-matching alone couldn't
safely resolve (confirmed against actual heading text/context, and in a
few cases against the original RST source, before applying):
- Typos and dropped words carried over from the original Sphinx docs
(e.g. "bot-acocunts", "auto-follow-all-new-channel-threads" ->
"follow-all-new-channel-threads").
- Sphinx auto-generated duplicate-heading IDs (#id1/#id3/#id4) resolved
to their real target headings.
- Numbered-step TOC links in enterprise-roll-out-checklist.mdx that
dropped the leading "N. " used in the actual heading slugs.
- Push-notification docs pointing at the wrong file entirely
(environment-configuration-settings instead of
push-notification-server-configuration-settings).
- SAML "saml-enterprise" label resolved to its true cross-file target
(authentication-configuration-settings#saml-2-0), recovered from the
original RST label definition that the automated registry missed
because it sat after an RST transition marker.
- sso-saml-technical references converted from broken same-page/
malformed-path anchors to correct page links.
* docs: fix SAML 2.0 anchor slug (saml-2-0 -> saml-20)
github-slugger strips periods rather than hyphenating them, so "SAML
2.0" slugifies to saml-20, not saml-2-0 as previously fixed.
* docs: fix broken path links found during docs/main migration cleanup
* docs: convert div.tab blocks to Docusaurus Tabs/TabItem components
* docs: restore missing Kubernetes deployment architecture diagrams
The RST-to-MDX migration never copied over the AWS/Azure/Oracle
architecture diagrams referenced by the deployment-architecture-at-scale
page, leaving broken images in each Tabs/TabItem.
* docs: fix 7 anchor mismatches from the fragment/heading audit
Covers three root causes from the anchor mismatch breakdown:
- Fragment repeated the target page's own title instead of a real
heading, so the link is simplified to point at the bare page.
- Heading exists verbatim but lives on a sibling settings page
(experimental-configuration-settings, push-notification-server-
configuration-settings) rather than environment-configuration-settings.
- A page path was mistakenly pasted into a same-page #fragment instead
of being used as a real cross-page link.
* docs: fix 8 anchor slugs that were close but didn't match the real heading
Repoints links whose fragment was a plausible guess (typo, reworded
heading, or wrong section) at the actual auto-generated slug of the
target heading, confirmed by inspecting each target page directly.
* docs: merge split Tabs blocks so tabs render horizontally
The div.tab conversion script split some sibling tab groups into
separate single-item Tabs blocks whenever a stray blockquote marker
sat between them, causing them to render stacked instead of as one
horizontal tab bar. Merges the MySQL/PostgreSQL and Team/Enterprise
Edition tab groups back into single Tabs blocks.
* docs: remove Azure tab and restore Kubernetes deploy content
The Mattermost Operator, Azure, and Oracle platform tabs on the
Kubernetes deployment guide were split across two separate Tabs
blocks (rendering stacked instead of as one tab bar) and all three
tab bodies were empty because the migration never flattened the
original RST include directives. Removes the unsupported Azure tab
and restores the Mattermost Operator and Oracle content from the
pre-migration RST sources as a single merged Tabs block.
* addresscoderabbitreview
* docs: unify Linux/Kubernetes/Containers deploy pages and fix FIPS/STIG placement
Kubernetes and Containers duplicated full install content across a top-level
page (Tabs) and orphaned sidebar subpages that nothing linked to. Reworked
both to follow the Linux page's pattern: shared content on the landing page,
platform-specific instructions live once in their own subpage.
Also removed configure-fips-at-install-time.mdx, which claimed FIPS is
available for native Linux installs — FIPS/STIG in Mattermost is a container
image property (Chainguard-based build), not available outside Docker/
Kubernetes. Consolidated all FIPS/STIG references onto
containers/fips-stig.mdx and pointed the Mattermost Operator subpage (not
Oracle OKE, which doesn't expose image selection) at it.
* docs: fix review findings — image alt text, Important callout markup, typo
- Replace generic alt="image" on scaling diagrams with descriptive text
identifying cloud provider and user scale.
- Convert raw div.important markup in deploy-containers.mdx to the
repo's <Important> component, matching usage elsewhere in the file.
- Fix "Matermost" typo in manage-your-display-options.mdx.
---------
Co-authored-by: Hanzo Dev <[email protected]>
145 lines
5.3 KiB
Plaintext
145 lines
5.3 KiB
Plaintext
---
|
|
title: "Deploy Mattermost on Ubuntu or Debian"
|
|
sidebar_label: "Ubuntu / Debian"
|
|
---
|
|
|
|
<EditionAvailability tiers="free,professional,enterprise,enterprise-advanced" />
|
|
<DeploymentAvailability modes="self-hosted" />
|
|
|
|
Install Mattermost Server on Ubuntu or Debian from the signed Mattermost APT repository. The same `.deb` packages cover single-host installs and clustered deployments via tools like Packer.
|
|
|
|
:::info Minimum requirements
|
|
- **Operating system**: Ubuntu 20.04 / 22.04 / 24.04 LTS, or Debian (current stable). Other Debian-family distributions usually work but aren't tested by Mattermost.
|
|
- **Hardware**: 1 vCPU and 2 GB RAM (supports up to ~1,000 users).
|
|
- **Database**: [PostgreSQL 14+](/deployment-guide/postgres-migration).
|
|
- **Network**: TCP 80/443 inbound (TLS), 8065 inbound (System Console), 10025 outbound (SMTP relay if used).
|
|
:::
|
|
|
|
## Step 1: Get a PostgreSQL database
|
|
|
|
Mattermost requires PostgreSQL. Choose one of:
|
|
|
|
- **Install PostgreSQL locally** on the same host. Follow the [PostgreSQL installation documentation](https://www.postgresql.org/download/).
|
|
- **Use an external PostgreSQL server**. Collect the connection credentials (hostname, port, database, username, password) before starting Step 2.
|
|
- **Use a managed database service** (AWS RDS, Azure Database for PostgreSQL, etc.).
|
|
|
|
## Step 2: Prepare the database
|
|
|
|
Follow the [database preparation](/deployment-guide/server/preparations#database-preparation) instructions to create the Mattermost database, user, and grants.
|
|
|
|
## Step 3: Add the Mattermost APT repository
|
|
|
|
:::important GPG key change
|
|
The GPG public key has changed. Either [import the new public key](https://deb.packages.mattermost.com/pubkey.gpg) or run the repository setup script in the next step (recommended). Existing installations should remove the old key before adding the new one:
|
|
|
|
For Ubuntu 22.04 LTS and 24.04 LTS:
|
|
|
|
```sh
|
|
sudo rm /usr/share/keyrings/mattermost-archive-keyring.gpg
|
|
curl -sL -o- https://deb.packages.mattermost.com/pubkey.gpg \
|
|
| gpg --dearmor \
|
|
| sudo tee /usr/share/keyrings/mattermost-archive-keyring.gpg > /dev/null
|
|
```
|
|
:::
|
|
|
|
Run the repository setup script:
|
|
|
|
```sh
|
|
curl -o- https://deb.packages.mattermost.com/repo-setup.sh | sudo bash -s mattermost
|
|
```
|
|
|
|
This configures the Mattermost APT repository, a PostgreSQL repository, an NGINX web server (used as a reverse proxy), and certbot for issuing and renewing SSL certificates.
|
|
|
|
## Step 4: Install Mattermost Server
|
|
|
|
Update your APT cache and any pending system packages:
|
|
|
|
```sh
|
|
sudo apt update
|
|
```
|
|
|
|
Install the latest Mattermost Server:
|
|
|
|
```sh
|
|
sudo apt install mattermost -y
|
|
```
|
|
|
|
Mattermost installs to `/opt/mattermost`. The package creates a `mattermost` user and group and a systemd unit file. The service is **not** enabled or started at this point.
|
|
|
|
:::note systemd dependencies
|
|
The Mattermost package doesn't declare a database dependency in its systemd unit (the package is used for both single-host and external-database installs). If you installed PostgreSQL on the same host, add the following to the `[Unit]` section of `/lib/systemd/system/mattermost.service`:
|
|
|
|
```ini
|
|
After=postgresql.service
|
|
BindsTo=postgresql.service
|
|
```
|
|
:::
|
|
|
|
## Step 5: Configure the server
|
|
|
|
Copy the default configuration to the active config file with the right ownership and permissions:
|
|
|
|
```sh
|
|
sudo install -C -m 600 -o mattermost -g mattermost \
|
|
/opt/mattermost/config/config.defaults.json \
|
|
/opt/mattermost/config/config.json
|
|
```
|
|
|
|
Edit `/opt/mattermost/config/config.json` and set:
|
|
|
|
- `SqlSettings.DriverName`: `"postgres"`
|
|
- `SqlSettings.DataSource`: `"postgres://mmuser:<mmuser-password>@<host>:5432/mattermost?sslmode=disable&connect_timeout=10"` — replace each placeholder.
|
|
- `ServiceSettings.SiteURL`: the public URL of your deployment (e.g., `https://mattermost.example.com`).
|
|
- (Recommended) [`SupportSettings.SupportEmail`](/administration-guide/configure/site-configuration-settings#support-email-address): the email address users contact for help.
|
|
|
|
:::note TLS mode for `DataSource`
|
|
The `sslmode` value depends on your database environment. The two relevant options are `disable` and `require`. Managed services such as AWS Lightsail require `sslmode=require`. Check your provider's documentation.
|
|
:::
|
|
|
|
Start the server:
|
|
|
|
```sh
|
|
sudo systemctl start mattermost
|
|
```
|
|
|
|
Verify it's running:
|
|
|
|
```sh
|
|
curl http://localhost:8065
|
|
```
|
|
|
|
You should see the Mattermost HTML response. Enable the service on boot:
|
|
|
|
```sh
|
|
sudo systemctl enable mattermost.service
|
|
```
|
|
|
|
## Step 6: Update Mattermost
|
|
|
|
When a new release is published, update through APT:
|
|
|
|
```sh
|
|
sudo systemctl stop mattermost
|
|
sudo apt update && sudo apt upgrade
|
|
sudo systemctl start mattermost
|
|
```
|
|
|
|
:::important Stop the server before upgrading
|
|
`apt upgrade` will replace the Mattermost binary while it's running. Stop the systemd service first to avoid corrupt state.
|
|
:::
|
|
|
|
## Remove Mattermost
|
|
|
|
```sh
|
|
sudo systemctl stop mattermost
|
|
sudo apt remove --purge mattermost
|
|
```
|
|
|
|
This removes the package but leaves `/opt/mattermost/data`, `/opt/mattermost/logs`, `/opt/mattermost/plugins`, and `/opt/mattermost/config` in place. Back these up before deleting if you may need to restore.
|
|
|
|
## Next steps
|
|
|
|
- [Set up an NGINX reverse proxy](/deployment-guide/server/setup-nginx-proxy)
|
|
- [Set up TLS](/deployment-guide/server/setup-tls)
|
|
- [Server deployment planning](/deployment-guide/server/server-deployment-planning) for the full post-install checklist
|