Bitnami Mattermost Team Edition Installer

NOTE: Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under "Start -> Bitnami APPNAME Stack -> Application console" (Windows). Learn more.
NOTE: When running the commands shown on this page, replace the installdir placeholder with the full installation directory for your Bitnami stack.
IMPORTANT: Mattermost requires a valid SSL certificate for some browsers. As Safari does not allow self-signed certificates for websockets connections, real-time communication may not work properly. You may see the following error on your browser console: "WebSocket network error: OSStatus Error -9809: Invalid certificate chain". Try using Google Chrome, Firefox or Internet Explorer instead. If you are running a production server, it is advisable that you set up a proper SSL certificate. Learn how to configure SSL certificates.

Description

Mattermost empowers organizations through secure, modern communication: open source team messaging and file sharing across web, mobile and PC, archiving, search and unlimited third-party integrations.

First steps with the Bitnami Mattermost Team Edition Stack

Welcome to your new Bitnami application! Here are a few questions (and answers!) you might need when first starting with your application.

What are the system requirements?

Before you download and install your application, check that your system meets these requirements.

How do I install the Bitnami Mattermost Team Edition Stack?

Windows, OS X and Linux installer
  • Download the executable file for the Bitnami Mattermost Team Edition Stack from the Bitnami website.

  • Run the downloaded file:

    • On Linux, give the installer executable permissions and run the installation file in the console.
    • On other platforms, double-click the installer and follow the instructions shown.

Check the FAQ instructions on how to download and install a Bitnami Stack for more details.

The application will be installed to the following default directories:

Operating System Directory
Windows C:\Bitnami\APPNAME-VERSION
Mac OS X /Applications/APPNAME-VERSION
Linux /opt/APPNAME-VERSION (running as root user)
OS X VM
  • Download the OS X VM file for the Bitnami Mattermost Team Edition Stack from the Bitnami website.
  • Begin the installation process by double-clicking the image file and dragging the WordPress OS X VM icon to the Applications folder.
  • Launch the VM by double-clicking the icon in the Applications folder.

What credentials do I need?

You need application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.

What is the administrator username set for me to log in to the application for the first time?

  • For Windows, Linux and OS X installers, the username was configured by you when you first installed the application.
  • For OS X VMs, the username can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

What is the administrator password?

  • For Windows, Linux and OS X installers, the password was configured by you when you first installed the application.
  • For OS X VMs, the password can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

How to start or stop the services?

Linux

Bitnami native installers include a graphical tool to manage services. This tool is named manager-linux-x64.run on Linux and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

      $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql, postgresql or apache:

      $ sudo installdir/ctlscript.sh restart mysql
      $ sudo installdir/ctlscript.sh restart postgresql
      $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

      $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Mac OS X

Bitnami native installers include a graphical tool to manage services. This tool is named manager-osx on Mac OS X and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ sudo installdir/ctlscript.sh restart mysql
     $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

NOTE: If you are using the stack manager for Mac OS X-VM, please check the following blog post to learn how to manage services from its graphical tool.

Windows

Bitnami native installers include a graphical tool to manage services. This tool is named manager-windows.exe on Windows and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The Windows native installer creates shortcuts to start and stop services created in the Start Menu, under "Programs -> Bitnami APPNAME Stack -> Bitnami Service". Servers can also be managed from the Windows "Services" control panel. Services are named using the format APPNAMESERVICENAME, where APPNAME is a placeholder for the application name and SERVICENAME is a placeholder for the service name. For example, the native installer for the Bitnami WordPress Stack installs services named wordpressApache and wordpressMySQL.

These services will be automatically started during boot. To modify this behaviour, refer to the section on disabling services on Windows.

How to configure outbound email settings?

Follow these steps:

  • Log in to Mattermost as an administrator.

  • Browse to the "System Console".

  • Navigate to the "Notifications -> Email" menu and set the values for your SMTP server. For example, to configure a Gmail server, use the values below. Remember to replace USERNAME and PASSWORD with your Gmail account username and password.
    • Enable Email Notifications: true
    • SMTP Server Username: USERNAME@gmail.com
    • SMTP Server Password: PASSWORD
    • SMTP Server: smtp.gmail.com
    • SMTP Server Port: 587
    • Connection Security: TLS
  • Click "Test Connection" to validate the connection. If the connection succeeds, click "Save" to save the changes.

    Mattermost SMTP configuration

To configure the application to use other third-party SMTP services for outgoing email, such as Hotmail or Amazon SES, refer to the Mattermost official documentation.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server and have experienced issues trying to send emails correctly, check the How to troubleshoot Gmail SMTP issues to learn the causes of these issues and how to solve them.

How to create a full backup of Mattermost Team Edition?

The Bitnami Mattermost Team Edition Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

NOTE: If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

Backup on Linux and Mac OS X

Follow these steps:

  • Change to the directory in which you wish to save your backup.

     $ cd /your/directory
    
  • Stop all servers.

     $ sudo installdir/ctlscript.sh stop
    
  • Create a compressed file with the stack contents.

     $ sudo tar -pczvf application-backup.tar.gz installdir
    
  • Start all servers.

     $ sudo installdir/ctlscript.sh start
    
  • Download or transfer the application-backup.tar.gz file to a safe location.

You should now download or transfer the application-backup.tar.gz file to a safe location.

Backup on Windows

Follow these steps:

  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip or just right-click the folder, click "Send to", and select the "Compressed (zipped) folder" option.

  • Download or transfer the compressed file to a safe location.

  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

Restore on Linux and Mac OS X

Follow these steps:

  • Change to the directory containing your backup:

    $ cd /your/directory
    
  • Stop all servers.

    $ sudo installdir/ctlscript.sh stop
    
  • Move the current stack to a different location:

    $ sudo mv installdir /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directory:

    $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers.

    $ sudo installdir/ctlscript.sh start
    
IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as the root user on Linux, make sure that the restored files are owned by root as well.

Restore on Windows

  • Change to the directory containing your backup:

       $ cd /your/directory
    
  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Uninstall the previous services by executing the following command:

        $ serviceinstall.bat
    
  • Create a safe folder named Backups in the desktop and move the current stack to it. Remember to replace PATH with the right location of your folder:

        $ move installdir \PATH\Backups
    
  • Uncompress the backup file using a tool like 7-Zip or Winzip or just double-click the .zip file to uncompress it, and move it to the original directory.
  • Install services by running the following commands from an elevated command prompt:

      $ cd installdir
      $ serviceinstall.bat INSTALL
    
  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

How to upgrade Mattermost?

It is strongly recommended to create a backup before starting the update process. If you have important data, create and restore a backup to ensure that everything works properly.

NOTE: If the stack was installed as the root user, prefix the commands below with sudo if not already present.

Follow these steps to upgrade Mattermost:

  • Stop the server:

     $ sudo installdir/ctlscript.sh stop mattermost
    
  • Back up the current configuration files:

     $ mkdir installdir/apps/mattermost/backup/
     $ cp installdir/apps/mattermost/server/config/config.json installdir/apps/mattermost/backup/
    
  • Back up the database as described on the MySQL page.

  • Back up the Mattermost data files:

     $ cp -r installdir/apps/mattermost/server/ installdir/apps/mattermost/backup/server
    
  • Download the latest version of Mattermost:

     $ cd installdir/apps/mattermost/
     $ wget https://releases.mattermost.com/X.X.X/mattermost-team-X.X.X-linux-amd64.tar.gz
    
  • Remove previous Mattermost files (already backed up in previous steps).

     $ rm -rf installdir/apps/mattermost/server/*
    
  • Uncompress the new version:

    $ tar xzf mattermost-team-X.X.X-linux-amd64.tar.gz -C installdir/apps/mattermost/server --strip-components=1
    
  • Restore the previous configuration file:

    $ cp installdir/apps/mattermost/backup/config.json installdir/apps/mattermost/server/config/config.json
    
  • Adjust file permissions as below.

    • If the stack was installed as the root user:

      $ chown -R root:root installdir/apps/mattermost/server
      $ touch installdir/apps/mattermost/server/logs/mattermost.log
      $ chown -R bitnami:mattermost installdir/apps/mattermost/server/logs
      $ chmod g+w installdir/apps/mattermost/server/logs/mattermost.log
      
    • If the stack was installed as a non-root user:

      $ chown -R bitnami:bitnami installdir/apps/mattermost/server
      $ touch installdir/apps/mattermost/server/logs/mattermost.log
      $ chown -R bitnami:mattermost installdir/apps/mattermost/server/logs
      $ chmod g+w installdir/apps/mattermost/server/logs/mattermost.log
      
  • Restart the server:

    $ sudo installdir/ctlscript.sh restart mattermost
    
  • Open the "System Console" and save a change. Doing this will upgrade your config.json schema to the latest version using default values for any new settings added.

How to create an SSL certificate?

You can create your own SSL certificate with the OpenSSL binary. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

NOTE: In the following steps, replace the APPNAME placeholder with the name of your application directory.
  • Generate a new private key:

     $ sudo openssl genrsa -out installdir/apps/APPNAME/conf/certs/server.key 2048
    
  • Create a certificate:

     $ sudo openssl req -new -key installdir/apps/APPNAME/conf/certs/server.key -out installdir/apps/APPNAME/conf/certs/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ sudo openssl x509 -in installdir/apps/APPNAME/conf/certs/cert.csr -out installdir/apps/APPNAME/conf/certs/server.crt -req -signkey installdir/apps/APPNAME/conf/certs/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ sudo openssl rsa -des3 -in installdir/apps/APPNAME/conf/certs/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the configuration file, Nginx won't be able to start. Regenerate the key without password protection from this file as follows:

     $ sudo openssl rsa -in privkey.pem -out installdir/apps/APPNAME/conf/certs/server.key
    

Find more information about certificates at http://www.openssl.org.

How to enable HTTPS support with SSL certificates?

TIP: If you wish to use a Let's Encrypt certificate, you will find specific instructions for enabling HTTPS support with Let's Encrypt SSL certificates in our Let's Encrypt guide.
NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your cloud server.

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

  • Use the table below to identify the correct locations for your certificate and configuration files.

    Variable Value
    Current application URL https://[custom-domain]/
      Example: https://my-domain.com/ or https://my-domain.com/appname
    Nginx configuration file installdir/nginx/conf/bitnami/bitnami.conf
    Certificate file installdir/nginx/conf/server.crt
    Certificate key file installdir/nginx/conf/server.key
  • Copy your SSL certificate and certificate key file to the specified locations.

  • Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

     $ sudo chown root:root installdir/nginx/conf/server*
    
     $ sudo chmod 600 installdir/nginx/conf/server*
    
  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart the Nginx server.

     $ sudo installdir/ctlscript.sh restart nginx
    

You should now be able to access your application using an HTTPS URL.

How to force HTTPS redirection with Nginx?

Modify the installdir/nginx/conf/bitnami/bitnami.conf file so that it looks like this:

server {
      listen 80;
      server_name localhost;
      return 301 https://$host$request_uri;
      include "installdir/nginx/conf/bitnami/bitnami-apps-prefix.conf";
  }

After modifying the Nginx configuration file:

  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart Nginx to apply the changes.

How to debug Nginx errors?

The Nginx log file is located at installdir/nginx/log/error.log.

If you configured Nginx to use a privileged port (port number < 1024), check that the Nginx server is running as user daemon in the configuration file. This user should also have write privileges to the installdir/nginx/log/ directory.

How to modify the allowed limit for uploaded files in the Nginx configuration?

The maximum size for uploaded files is set to 1MB by default in the Nginx configuration. You can add the following option at the end of this file installdir/apps/APP_NAME/conf/nginx-app.conf to increase the allowed size for uploads. Replace the APP_NAME placeholder with the correct directory name.

client_max_body_size SIZE;
NOTE: Remember to replace the SIZE placeholder with the value you want to set. For example: client_max_body_size 8m;.
  • Restart PHP-FPM and Nginx for the changes to take effect.

    $ sudo installdir/ctlscript.sh restart nginx
    $ sudo installdir/ctlscript.sh restart php-fpm
    

Updating the IP address or hostname

Mattermost Team Edition requires updating the IP address/domain name if the machine IP address/domain name changes. The bnconfig tool also has an option which updates the IP address, called --machine_hostname (use --help to check if that option is available for your application). Note that this tool changes the URL to http://NEW_DOMAIN/mattermost.

$ sudo installdir/apps/mattermost/bnconfig --machine_hostname NEW_DOMAIN

If you have configured your machine to use a static domain name or IP address, you should rename or remove the installdir/apps/mattermost/bnconfig file.

$ sudo mv installdir/apps/mattermost/bnconfig installdir/apps/mattermost/bnconfig.disabled
NOTE: Be sure that your domain is propagated. Otherwise, this will not work. You can verify the new DNS record by using the Global DNS Propagation Checker and entering your domain name into the search field.

You can also change your hostname by modifying it in your hosts file. Enter the new hostname using your preferred editor.

$ sudo nano /etc/hosts
  • Add a new line with the IP address and the new hostname. Here's an example. Remember to replace the IP-ADDRESS and DOMAIN placeholders with the correct IP address and domain name.

    IP-ADDRESS DOMAIN

How to find the MySQL database credentials?

How to connect to the MySQL database?

You can connect to the MySQL database from the same computer where it is installed with the mysql client tool.

$ mysql -u root -p

You will be prompted to enter the root user password. This is the same as the application password.

How to debug errors in your database?

The main log file is created at installdir/mysql/data/mysqld.log on the MySQL database server host.

How to change the MySQL root password?

You can modify the MySQL password using the following command at the shell prompt. Replace the NEW_PASSWORD placeholder with the actual password you wish to set.

$ installdir/mysql/bin/mysqladmin -p -u root password NEW_PASSWORD

How to reset the MySQL root password?

If you don't remember your MySQL root password, you can follow the steps below to reset it to a new value:

  • Create a file in /home/bitnami/mysql-init with the content shown below (replace NEW_PASSWORD with the password you wish to use):

     UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') WHERE User='root';
     FLUSH PRIVILEGES;
    

    If your stack ships MySQL v5.7.x, use the following content instead of that shown above:

     UPDATE mysql.user SET authentication_string=PASSWORD('NEW_PASSWORD') WHERE User='root';
     FLUSH PRIVILEGES;
    
    TIP: Check the MySQL version with the command installdir/mysql/bin/mysqladmin --version or installdir/mysql/bin/mysqld --version.
  • Stop the MySQL server:

     $ sudo installdir/ctlscript.sh stop mysql
    
  • Start MySQL with the following command:

     $ sudo installdir/mysql/bin/mysqld_safe --pid-file=installdir/mysql/data/mysqld.pid --datadir=installdir/mysql/data --init-file=/home/bitnami/mysql-init 2> /dev/null &
    
  • Restart the MySQL server:

     $ sudo installdir/ctlscript.sh restart mysql
    
  • Remove the script:

     $ rm /home/bitnami/mysql-init
    

How to change the MySQL root password in Windows?

You can modify the MySQL password using the following command at the shell prompt. Replace the NEW_PASSWORD placeholder with the actual password you wish to set.

installdir\mysql\bin\mysqladmin.exe -p -u root password NEW_PASSWORD

How to reset the MySQL root password in Windows?

If you don't remember your MySQL root password, you can follow the steps below to reset it to a new value:

  • Stop the MySQL server using the graphic manager tool. Refer to the how to start or stop the services section.
  • Check the MySQL version:

    installdir\mysql\bin\mysqladmin.exe –version

  • Create a file named mysql-init.txt with the content shown below depending on your MySQL version (replace NEW_PASSWORD with the password you wish to use):
    • MySQL 5.6.x or earlier:

       UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') 
       WHERE User='root';
       FLUSH PRIVILEGES;
      
    • MySQL 5.7.x or later:

       ALTER USER 'root'@'localhost' IDENTIFIED BY 'NEW_PASSWORD'; 
      
  • Start MySQL server with the following command. Remember to replace PATH with the location in which you have saved the mysql-init.txt file:

     installdir " installdir\mysql\bin\mysqld.exe" --defaults-file=" installdir\mysql\my.ini" --init-file="\PATH\mysql-init.txt" --console
    
    • The --init file option is used by the server for executing the content of the mysql-init.txt file at startup, it will change each root account password.
    • The --defaults-file option is specified since you have installed MySQL using the Bitnami installer.
    • The --console option (optional) has been added in order to show the server output at the console window rather than in the log file.
  • After some minutes, hit Ctrl-C to force the shutdown.
  • Restart the MySQL server from the graphic manager tool.
  • After the server has restarted successfully, delete the mysql-init.txt file.

Troubleshooting Mattermost Team Edition

How to debug errors in Mattermost Team Edition?

The Mattermost Team Edition logs are stored at installdir/apps/mattermost/htdocs/logs/mattermost.log.

Where can I learn more about Mattermost?

Learn more from the Mattermost website and the Mattermost Github repository.

nativeInstaller

Bitnami Documentation