diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/install/Configuration-Settings.md | 46 | ||||
| -rw-r--r-- | doc/install/LDAP-Setup.md | 34 | ||||
| -rw-r--r-- | doc/install/Production-Debian.md | 29 | ||||
| -rw-r--r-- | doc/install/Production-RHEL6.md | 219 | ||||
| -rw-r--r-- | doc/install/Production-RHEL7.md | 226 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md | 14 | ||||
| -rw-r--r-- | doc/process/release-process.md | 224 |
7 files changed, 686 insertions, 106 deletions
diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index 5f9b3b62d..c18012af8 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -289,6 +289,52 @@ Enter `https://<your-gitlab-url>/oauth/authorize` (example: `https://example.com ```"UserApiEndpoint": ""``` Enter `https://<your-gitlab-url>/oauth/authorize` (example: `https://example.com:3000/api/v3/user`). Use HTTP or HTTPS depending on how your server is configured. +### LDAP Settings (Enterprise) + +Settings used to enable and configure LDAP authentication with Mattermost. Available in the Enterprise version of Mattermost. + +```"Enable Login With LDAP": "false"``` +When true, Mattermost allows login using LDAP. + +```“LDAP Server”: “”``` +The domain or IP address of the LDAP server. + +```“LDAP Port”: “389”``` +The port Mattermost will use to connect to the LDAP server. Default is 389. + +```”BaseDN”: ””``` +The Base DN is the Distinguished Name of the location where Mattermost should start its search for users in the LDAP tree. + +```”Bind Username”: ””``` +The username used to perform the LDAP search. This should typically be an account created specifically for use with Mattermost. It should be a read only account with access limited to the portion of the LDAP tree specified in the BaseDN field. + +```”Bind Password”: ””``` +Password of the user given in “Bind Username”. + +```”First Name Attribute”: ””``` +The attribute in the LDAP server that will be used to populate the first name of users in Mattermost. + +```”Last Name Attribute”: ””``` +The attribute in the LDAP server that will be used to populate the last name of users in Mattermost. + +```”Email Attribute”: ””``` +The attribute in the LDAP server that will be used to populate the email addresses of users in Mattermost. + +```”Username Attribute”: ””``` +The attribute in the LDAP server that will be used to populate the username field in Mattermost. This may be the same as the ID Attribute. + +```”ID Attribute”: ””``` + +The attribute in the LDAP server that will be used as a unique identifier in Mattermost. + +This is the attribute that will be used to create Mattermost accounts. It should be an LDAP attribute with a value that does not change, such as username or uid. If a user’s Id Attribute changes, it will create a new Mattermost account unassociated with their old one. + +This is also the value used to log in to Mattermost in the “LDAP Username” field on the sign in page. Normally this attribute is the same as the “Username Attribute” field above. If your team typically uses domain\username to sign in to other services with LDAP, you may choose to put domain\username in this field to maintain consistency between sites. + +```”Query Timeout (seconds)”: ”60”``` + +The timeout value for queries to the LDAP server. Increase this value if you are getting timeout errors caused by a slow LDAP server. + ## Config.json Settings Not in System Console System Console allows an IT Admin to update settings defined in `config.json`. However there are a number of settings in `config.json` unavailable in the System Console and require update from the file itself. We describe them here: diff --git a/doc/install/LDAP-Setup.md b/doc/install/LDAP-Setup.md new file mode 100644 index 000000000..a619e645e --- /dev/null +++ b/doc/install/LDAP-Setup.md @@ -0,0 +1,34 @@ +## LDAP Setup + +LDAP authentication is available in the Enterprise version of Mattermost. +### How to enable LDAP + +After installing Mattermost: + +1. Create a team using email authentication + - Note: The first account used to create a team will be the “System Administrator” account, used to configure settings for your Mattermost site + 3. Go to Main Menu (the three dots near your team name in the top left of your screen) > **System Console** + 4. Go to LDAP Settings + 5. Fill in the fields to set up Mattermost authentication with your LDAP server + + After LDAP has been enabled, users should be able to go to your Mattermost site and sign in using their LDAP credentials. The “LDAP username” will be the attribute set in the “Id Attribute” field. + + **Note: In the initial implementation of LDAP, if a user attribute changes on the LDAP server it will be updated the next time the user enters their credentials to log in to Mattermost. This includes if a user is made inactive or removed from an LDAP server. Synchronization with LDAP servers is planned in a future release.** + +### Switching System Administrator account to LDAP authentication + +If you would like to switch your System Administrator account to LDAP authentication, it is recommended you do the following: + +1. Create a new account using LDAP + - Note: If your LDAP credentials use the same email address as your System Administrator account, it is recommended you change the email on your System Administrator account by going to Main Menu -> Account Settings -> General -> Email. This will free up the email address so it can be used by the LDAP account. + 2. Sign in to your email based System Administrator account + 3. Navigate to the System Console + 4. Go to Teams -> Team Name -> Users, and find your new LDAP user account + 5. Promote your LDAP account to “System Administrator” using the dropdown menu beside the username + 6. Log in with your LDAP account + 7. Navigate to the System Console + 8. Go to Teams -> Team Name -> Users, and find your old email based System Administrator account + 9. Make the email account “Inactive” using the dropdown beside the username + + **Note: If you make the email account inactive without promoting another account to System Administrator, you will lose your System Administrator privileges. This can be fixed by promoting another account to System Administrator using the command line.** + diff --git a/doc/install/Production-Debian.md b/doc/install/Production-Debian.md index 13ff051a3..4b942a088 100644 --- a/doc/install/Production-Debian.md +++ b/doc/install/Production-Debian.md @@ -13,6 +13,7 @@ Note: This install guide has been generously contributed by the Mattermost commu * ``` sudo apt-get update``` * ``` sudo apt-get upgrade``` + ## Set up Database Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.1 1. Install PostgreSQL 9.3+ (or MySQL 5.6+) @@ -31,22 +32,36 @@ Note: This install guide has been generously contributed by the Mattermost commu * ```postgre=# \q``` 1. You can exit the postgres account by typing: * ``` exit``` +1. Allow Postgres to listen on all assigned IP Addresses + * ```sudo vi /etc/postgresql/9.3/main/postgresql.conf``` + * Uncomment 'listen_addresses' and change 'localhost' to '*' +1. Alter pg_hba.conf to allow the mattermost server to talk to the postgres database + * ```sudo vi /etc/postgresql/9.3/main/pg_hba.conf``` + * Add the following line to the 'IPv4 local connections' + * host all all 10.10.10.2/32 md5 +1. Reload Postgres database + * ```sudo /etc/init.d/postgresql reload``` +1. Attempt to connect with the new created user to verify everything looks good + * ```psql --host=10.10.10.1 --dbname=mattermost --username=mmuser --password``` + * ```mattermost=> \q``` + ## Set up Mattermost Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.2 1. Download the latest Mattermost Server by typing: - * ``` wget https://github.com/mattermost/platform/releases/download/v1.1.0/mattermost.tar.gz``` + * ``` wget https://github.com/mattermost/platform/releases/download/v1.3.0/mattermost.tar.gz``` 1. Install Mattermost under /opt - * ``` cd /opt``` * Unzip the Mattermost Server by typing: * ``` tar -xvzf mattermost.tar.gz``` -1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/mattermost/data`. + * ``` sudo mv mattermost /opt``` +1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/opt/mattermost/data`. * Create the directory by typing: * ``` sudo mkdir -p /opt/mattermost/data``` 1. Create a system user and group called mattermost that will run this service - * ``` useradd -r mattermost -U``` + * ``` sudo useradd -r mattermost -U``` * Set the mattermost account as the directory owner by typing: * ``` sudo chown -R mattermost:mattermost /opt/mattermost``` + * ``` sudo chmod -R g+w /opt/mattermost``` * Add yourself to the mattermost group to ensure you can edit these files: * ``` sudo usermod -aG mattermost USERNAME``` 1. Configure Mattermost Server by editing the config.json file at /opt/mattermost/config @@ -183,7 +198,7 @@ esac exit 0 ``` * Make sure that /etc/init.d/mattermost is executable - * ``` chmod +x /etc/init.d/mattermost``` + * ``` sudo chmod +x /etc/init.d/mattermost``` 1. On reboot, systemd will generate a unit file from the headers in this init script and install it in `/run/systemd/generator.late/` ## Set up Nginx Server @@ -207,7 +222,7 @@ exit 0 * Create a configuration for Mattermost * ``` sudo touch /etc/nginx/sites-available/mattermost``` * Below is a sample configuration with the minimum settings required to configure Mattermost - ``` +``` server { server_name mattermost.example.com; location / { @@ -276,6 +291,8 @@ exit 0 gzip off; proxy_set_header X-Forwarded-Ssl on; ``` + + ## Finish Mattermost Server setup 1. Navigate to https://mattermost.example.com and create a team and user. 1. The first user in the system is automatically granted the `system_admin` role, which gives you access to the System Console. diff --git a/doc/install/Production-RHEL6.md b/doc/install/Production-RHEL6.md new file mode 100644 index 000000000..e3c6423c3 --- /dev/null +++ b/doc/install/Production-RHEL6.md @@ -0,0 +1,219 @@ +# Production Installation on Red Hat Enterprise Linux 6.6 + +## Install Red Hat Enterprise Linux (x64) 6.6 +1. Set up 3 machines with RHEL with 2GB of RAM or more. The servers will be used for the Load Balancer, Mattermost (this must be x64 to use pre-built binaries), and Database. + - **Optional:** You can also use a single machine for all 3 components in this install guide, depending on the standards of your data center. +2. Make sure the system is up to date with the most recent security patches. + * ``` sudo yum update``` + * ``` sudo yum upgrade``` + +## Set up Database Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.1` + - **Optional:** if installing on the same machine substitute `10.10.10.1` with `127.0.0.1` +1. Install PostgreSQL 9.4+ (or MySQL 5.6+) + * ``` sudo yum install http://yum.postgresql.org/9.4/redhat/rhel-6-x86_64/pgdg-redhat94-9.4-1.noarch.rpm``` + * ``` sudo yum install postgresql94-server postgresql94-contrib``` + * ``` sudo service postgresql-9.4 initdb``` + * ``` sudo chkconfig postgresql-9.4 on``` + * ``` sudo service postgresql-9.4 start``` +1. PostgreSQL created a user account called `postgres`. You will need to log into that account with: + * ``` sudo -i -u postgres``` +1. You can get a PostgreSQL prompt by typing: + * ``` psql``` +1. Create the Mattermost database by typing: + * ```postgres=# CREATE DATABASE mattermost;``` +1. Create the Mattermost user by typing: + * ```postgres=# CREATE USER mmuser WITH PASSWORD 'mmuser_password';``` +1. Grant the user access to the Mattermost database by typing: + * ```postgres=# GRANT ALL PRIVILEGES ON DATABASE mattermost to mmuser;``` +1. You can exit out of PostgreSQL by typing: + * ```postgres=# \q``` +1. You can exit the Postgres account by typing: + * ``` exit``` +1. Allow Postgres to listen on all assigned IP Addresses: + * ```sudo vi /var/lib/pgsql/9.4/data/postgresql.conf``` + * Uncomment 'listen_addresses' and change 'localhost' to '*' +1. Alter `pg_hba.conf` to allow the Mattermost Server to talk to the Postgres database: + * ```sudo vi /var/lib/pgsql/9.4/data/pg_hba.conf``` + * Add the following line to the 'IPv4 local connections': + * host all all 10.10.10.2/32 md5 +1. Reload Postgres database: + * ```sudo service postgresql-9.4 restart``` +1. Attempt to connect with the new created user to verify everything looks good: + * ```psql --host=10.10.10.1 --dbname=mattermost --username=mmuser --password``` + * ```mattermost=> \q``` + + +## Set up Mattermost Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.2` +1. Download the latest Mattermost Server by typing: + * ``` wget https://github.com/mattermost/platform/releases/download/v1.3.0/mattermost.tar.gz``` +1. Install Mattermost under `/opt` + * Unzip the Mattermost Server by typing: + * ``` tar -xvzf mattermost.tar.gz``` + * ``` sudo mv mattermost /opt``` +1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/opt/mattermost/data`. + * Create the directory by typing: + * ``` sudo mkdir -p /opt/mattermost/data``` +1. Create a system user and group called mattermost that will run this service: + * ``` sudo useradd -r mattermost -U``` + * Set the Mattermost account as the directory owner by typing: + * ``` sudo chown -R mattermost:mattermost /opt/mattermost``` + * ``` sudo chmod -R g+w /opt/mattermost``` + * Add yourself to the mattermost group to ensure you can edit these files: + * ``` sudo usermod -a -G mattermost USERNAME``` +1. Configure Mattermost Server by editing the `config.json` file at `/opt/mattermost/config` + * ``` cd /opt/mattermost/config``` + * Edit the file by typing: + * ``` sudo vi config.json``` + * replace `DriverName": "mysql"` with `DriverName": "postgres"` + * replace `"DataSource": "mmuser:mostest@tcp(dockerhost:3306)/mattermost_test?charset=utf8mb4,utf8"` with `"DataSource": "postgres://mmuser:mmuser_password@10.10.10.1:5432/mattermost?sslmode=disable&connect_timeout=10"` + * Optionally you may continue to edit configuration settings in `config.json` or use the System Console described in a later section to finish the configuration. +1. Test the Mattermost Server + * ``` cd /opt/mattermost/bin``` + * Run the Mattermost Server by typing: + * ``` sudo su mattermost``` + * ``` ./platform``` + * You should see a console log like `Server is listening on :8065` letting you know the service is running. + * Stop the server for now by typing `Ctrl-C` +1. Setup Mattermost to use the Upstart daemon which handles supervision of the Mattermost process. + * ``` sudo touch /etc/init/mattermost.conf``` + * ``` sudo vi /etc/init/mattermost.conf``` + * Copy the following lines into `/etc/init/mattermost.conf` +``` +start on runlevel [2345] +stop on runlevel [016] +respawn +chdir /opt/mattermost +exec bin/platform +``` + * You can manage the process by typing: + * ``` sudo start mattermost``` + * Verify the service is running by typing: + * ``` curl http://10.10.10.2:8065``` + * You should see a page titles *Mattermost - Signup* + * You can also stop the process by running the command ` sudo stop mattermost`, but we will skip this step for now. + +## Set up Nginx Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.3` +1. We use Nginx for proxying request to the Mattermost Server. The main benefits are: + * SSL termination + * HTTP to HTTPS redirect + * Port mapping :80 to :8065 + * Standard request logs +1. Install Nginx on RHEL with + * ``` sudo vi /etc/yum.repos.d/nginx.repo``` + * Copy the below into the file +``` +[nginx] +name=nginx repo +baseurl=http://nginx.org/packages/rhel/6/$basearch/ +gpgcheck=0 +enabled=1 +``` + * ``` sudo yum install nginx.x86_64``` + * ``` sudo service nginx start``` + * ``` sudo chkconfig nginx on``` +1. Verify Nginx is running + * ``` curl http://10.10.10.3``` + * You should see a *Welcome to nginx!* page +1. Map a FQDN (fully qualified domain name) like **mattermost.example.com** to point to the Nginx server. +1. Configure Nginx to proxy connections from the internet to the Mattermost Server + * Create a configuration for Mattermost + * ``` sudo touch /etc/nginx/conf.d/mattermost.conf``` + * Below is a sample configuration with the minimum settings required to configure Mattermost +``` + server { + server_name mattermost.example.com; + location / { + client_max_body_size 50M; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + 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_pass http://10.10.10.2:8065; + } + } +``` + * Remove the existing file with: + * ``` sudo mv /etc/nginx/conf.d/default.conf /etc/nginx/conf.d/default.conf.bak``` + * Restart Nginx by typing: + * ``` sudo service nginx restart``` + * Verify you can see Mattermost thru the proxy by typing: + * ``` curl http://localhost``` + * You should see a page titles *Mattermost - Signup* + * Not seeing the page? Look for errors with ``` sudo cat /var/log/audit/audit.log | grep nginx | grep denied``` + * **Optional** if you're running on the same server as the Mattermost server and see 502 errors you may need to run `sudo setsebool -P httpd_can_network_connect true` because SELinux is preventing the connection + +## Set up Nginx with SSL (Recommended) +1. You will need a SSL cert from a certificate authority. +1. For simplicity we will generate a test certificate. + * ``` mkdir /top/mattermost/cert``` + * ``` cd /top/mattermost/cert``` + * ``` sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout mattermost.key -out mattermost.crt``` + * Input the following info +``` + Country Name (2 letter code) [AU]:US + State or Province Name (full name) [Some-State]:California + Locality Name (eg, city) []:Palo Alto + Organization Name (eg, company) [Internet Widgits Pty Ltd]:Example LLC + Organizational Unit Name (eg, section) []: + Common Name (e.g. server FQDN or YOUR name) []:mattermost.example.com + Email Address []:admin@mattermost.example.com +``` +1. Modify the file at `/etc/nginx/conf.d/mattermost.conf` and add the following lines + * +``` + server { + listen 80; + server_name mattermost.example.com; + return 301 https://$server_name$request_uri; + } + + server { + listen 443 ssl; + server_name mattermost.example.com; + + ssl on; + ssl_certificate /opt/mattermost/cert/mattermost.crt; + ssl_certificate_key /opt/mattermost/cert/mattermost.key; + ssl_session_timeout 5m; + ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2; + ssl_ciphers "HIGH:!aNULL:!MD5 or HIGH:!aNULL:!MD5:!3DES"; + ssl_prefer_server_ciphers on; + ssl_session_cache shared:SSL:10m; + + # add to location / above + location / { + gzip off; + proxy_set_header X-Forwarded-Ssl on; +``` + +## Finish Mattermost Server setup +1. Navigate to `https://mattermost.example.com` and create a team and user. +1. The first user in the system is automatically granted the `system_admin` role, which gives you access to the System Console. +1. From the `town-square` channel click the dropdown and choose the `System Console` option +1. Update Email Settings. We recommend using an email sending service. The example below assumes AmazonSES. + * Set *Send Email Notifications* to true + * Set *Require Email Verification* to true + * Set *Feedback Name* to `No-Reply` + * Set *Feedback Email* to `mattermost@example.com` + * Set *SMTP Username* to `AFIADTOVDKDLGERR` + * Set *SMTP Password* to `DFKJoiweklsjdflkjOIGHLSDFJewiskdjf` + * Set *SMTP Server* to `email-smtp.us-east-1.amazonaws.com` + * Set *SMTP Port* to `465` + * Set *Connection Security* to `TLS` + * Save the Settings +1. Update File Settings: + * Change *Local Directory Location* from `./data/` to `/opt/mattermost/data` +1. Update Log Settings: + * Set *Log to The Console* to `false` +1. Update Rate Limit Settings: + * Set *Vary By Remote Address* to false + * Set *Vary By HTTP Header* to X-Real-IP +1. Feel free to modify other settings +1. Restart the Mattermost Service by typing: + * ``` sudo restart mattermost``` diff --git a/doc/install/Production-RHEL7.md b/doc/install/Production-RHEL7.md new file mode 100644 index 000000000..a479ec5ad --- /dev/null +++ b/doc/install/Production-RHEL7.md @@ -0,0 +1,226 @@ +# Production Installation on Red Hat Enterprise Linux 7.1+ + +## Install Red Hat Enterprise Linux (x64) 7.1+ +1. Set up 3 machines with RHEL with 2GB of RAM or more. The servers will be used for the Load Balancer, Mattermost (this must be x64 to use pre-built binaries), and Database. + - **Optional:** You can also use a single machine for all 3 components in this install guide, depending on the standards of your data center. +2. Make sure the system is up to date with the most recent security patches. + * ``` sudo yum update``` + * ``` sudo yum upgrade``` + +## Set up Database Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.1` + - **Optional:** if installing on the same machine substitute `10.10.10.1` with `127.0.0.1` +1. Install PostgreSQL 9.4+ (or MySQL 5.6+) + * ``` sudo yum install http://yum.postgresql.org/9.4/redhat/rhel-6-x86_64/pgdg-redhat94-9.4-1.noarch.rpm``` + * ``` sudo yum install postgresql94-server postgresql94-contrib``` + * ``` sudo /usr/pgsql-9.4/bin/postgresql94-setup initdb``` + * ``` sudo systemctl enable postgresql-9.4.service``` + * ``` sudo systemctl start postgresql-9.4.service``` +1. PostgreSQL created a user account called `postgres`. You will need to log into that account with: + * ``` sudo -i -u postgres``` +1. You can get a PostgreSQL prompt by typing: + * ``` psql``` +1. Create the Mattermost database by typing: + * ```postgres=# CREATE DATABASE mattermost;``` +1. Create the Mattermost user by typing: + * ```postgres=# CREATE USER mmuser WITH PASSWORD 'mmuser_password';``` +1. Grant the user access to the Mattermost database by typing: + * ```postgres=# GRANT ALL PRIVILEGES ON DATABASE mattermost to mmuser;``` +1. You can exit out of PostgreSQL by typing: + * ```postgres=# \q``` +1. You can exit the Postgres account by typing: + * ``` exit``` +1. Allow Postgres to listen on all assigned IP Addresses: + * ```sudo vi /var/lib/pgsql/9.4/data/postgresql.conf``` + * Uncomment 'listen_addresses' and change 'localhost' to '*' +1. Alter `pg_hba.conf` to allow the Mattermost Server to talk to the Postgres database: + * ```sudo vi /var/lib/pgsql/9.4/data/pg_hba.conf``` + * Add the following line to the 'IPv4 local connections': + * host all all 10.10.10.2/32 md5 +1. Reload Postgres database: + * ```sudo systemctl reload postgresql-9.4.service``` +1. Attempt to connect with the new created user to verify everything looks good: + * ```psql --host=10.10.10.1 --dbname=mattermost --username=mmuser --password``` + * ```mattermost=> \q``` + + +## Set up Mattermost Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.2` +1. Download the latest Mattermost Server by typing: + * ``` wget https://github.com/mattermost/platform/releases/download/v1.3.0/mattermost.tar.gz``` +1. Install Mattermost under `/opt` + * Unzip the Mattermost Server by typing: + * ``` tar -xvzf mattermost.tar.gz``` + * ``` sudo mv mattermost /opt``` +1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/opt/mattermost/data`. + * Create the directory by typing: + * ``` sudo mkdir -p /opt/mattermost/data``` +1. Create a system user and group called mattermost that will run this service: + * ``` sudo useradd -r mattermost -U``` + * Set the Mattermost account as the directory owner by typing: + * ``` sudo chown -R mattermost:mattermost /opt/mattermost``` + * ``` sudo chmod -R g+w /opt/mattermost``` + * Add yourself to the mattermost group to ensure you can edit these files: + * ``` sudo usermod -aG mattermost USERNAME``` +1. Configure Mattermost Server by editing the `config.json` file at `/opt/mattermost/config` + * ``` cd /opt/mattermost/config``` + * Edit the file by typing: + * ``` sudo vi config.json``` + * replace `DriverName": "mysql"` with `DriverName": "postgres"` + * replace `"DataSource": "mmuser:mostest@tcp(dockerhost:3306)/mattermost_test?charset=utf8mb4,utf8"` with `"DataSource": "postgres://mmuser:mmuser_password@10.10.10.1:5432/mattermost?sslmode=disable&connect_timeout=10"` + * Optionally you may continue to edit configuration settings in `config.json` or use the System Console described in a later section to finish the configuration. +1. Test the Mattermost Server + * ``` cd /opt/mattermost/bin``` + * Run the Mattermost Server by typing: + * ``` ./platform``` + * You should see a console log like `Server is listening on :8065` letting you know the service is running. + * Stop the server for now by typing `Ctrl-C` +1. Set up Mattermost to use the systemd init daemon which handles supervision of the Mattermost process: + * ``` sudo touch /etc/systemd/system/mattermost.service``` + * ``` sudo vi /etc/systemd/system/mattermost.service``` + * Copy the following lines into `/etc/systemd/system/mattermost.service` +``` +[Unit] +Description=Mattermost +After=syslog.target network.target + +[Service] +Type=simple +WorkingDirectory=/opt/mattermost/bin +User=mattermost +ExecStart=/opt/mattermost/bin/platform +PIDFile=/var/spool/mattermost/pid/master.pid + +[Install] +WantedBy=multi-user.target +``` + * Make sure the service is executable with ``` sudo chmod 664 /etc/systemd/system/mattermost.service``` + * Reload the services with `sudo systemctl daemon-reload` + * Start Mattermost service with `sudo systemctl start mattermost.service` + * `sudo chkconfig mattermost on` + * Start server on reboot `sudo systemctl enable mattermost.service` + + +## Set up Nginx Server +1. For the purposes of this guide we will assume this server has an IP address of `10.10.10.3` +1. We use Nginx for proxying request to the Mattermost Server. The main benefits are: + * SSL termination + * HTTP to HTTPS redirect + * Port mapping :80 to :8065 + * Standard request logs +1. Install Nginx on RHEL with + * ``` sudo vi /etc/yum.repos.d/nginx.repo``` + * Copy the below into the file +``` +[nginx] +name=nginx repo +baseurl=http://nginx.org/packages/rhel/7/$basearch/ +gpgcheck=0 +enabled=1 +``` + * ``` sudo yum install nginx.x86_64``` + * ``` sudo service nginx start``` + * ``` sudo chkconfig nginx on``` +1. Verify Nginx is running + * ``` curl http://10.10.10.3``` + * You should see a *Welcome to nginx!* page +1. Map a FQDN (fully qualified domain name) like **mattermost.example.com** to point to the Nginx server. +1. Configure Nginx to proxy connections from the internet to the Mattermost Server + * Create a configuration for Mattermost + * ``` sudo touch /etc/nginx/conf.d/mattermost.conf``` + * Below is a sample configuration with the minimum settings required to configure Mattermost +``` + server { + server_name mattermost.example.com; + location / { + client_max_body_size 50M; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + 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_pass http://10.10.10.2:8065; + } + } +``` + * Remove the existing file with: + * ``` sudo mv /etc/nginx/conf.d/default.conf /etc/nginx/conf.d/default.conf.bak``` + * Restart Nginx by typing: + * ``` sudo service nginx restart``` + * Verify you can see Mattermost thru the proxy by typing: + * ``` curl http://localhost``` + * You should see a page titles *Mattermost - Signup* + * Not seeing the page? Look for errors with ``` sudo cat /var/log/audit/audit.log | grep nginx | grep denied``` + * **Optional** if you're running on the same server as the Mattermost server and see 502 errors you may need to run `sudo setsebool -P httpd_can_network_connect true` because SELinux is preventing the connection + +## Set up Nginx with SSL (Recommended) +1. You will need a SSL cert from a certificate authority. +1. For simplicity we will generate a test certificate. + * ``` mkdir /top/mattermost/cert``` + * ``` cd /top/mattermost/cert``` + * ``` sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout mattermost.key -out mattermost.crt``` + * Input the following info +``` + Country Name (2 letter code) [AU]:US + State or Province Name (full name) [Some-State]:California + Locality Name (eg, city) []:Palo Alto + Organization Name (eg, company) [Internet Widgits Pty Ltd]:Example LLC + Organizational Unit Name (eg, section) []: + Common Name (e.g. server FQDN or YOUR name) []:mattermost.example.com + Email Address []:admin@mattermost.example.com +``` +1. Modify the file at `/etc/nginx/conf.d/mattermost.conf` and add the following lines + * +``` + server { + listen 80; + server_name mattermost.example.com; + return 301 https://$server_name$request_uri; + } + + server { + listen 443 ssl; + server_name mattermost.example.com; + + ssl on; + ssl_certificate /opt/mattermost/cert/mattermost.crt; + ssl_certificate_key /opt/mattermost/cert/mattermost.key; + ssl_session_timeout 5m; + ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2; + ssl_ciphers "HIGH:!aNULL:!MD5 or HIGH:!aNULL:!MD5:!3DES"; + ssl_prefer_server_ciphers on; + ssl_session_cache shared:SSL:10m; + + # add to location / above + location / { + gzip off; + proxy_set_header X-Forwarded-Ssl on; +``` + +## Finish Mattermost Server setup +1. Navigate to `https://mattermost.example.com` and create a team and user. +1. The first user in the system is automatically granted the `system_admin` role, which gives you access to the System Console. +1. From the `town-square` channel click the dropdown and choose the `System Console` option +1. Update Email Settings. We recommend using an email sending service. The example below assumes AmazonSES. + * Set *Send Email Notifications* to true + * Set *Require Email Verification* to true + * Set *Feedback Name* to `No-Reply` + * Set *Feedback Email* to `mattermost@example.com` + * Set *SMTP Username* to `AFIADTOVDKDLGERR` + * Set *SMTP Password* to `DFKJoiweklsjdflkjOIGHLSDFJewiskdjf` + * Set *SMTP Server* to `email-smtp.us-east-1.amazonaws.com` + * Set *SMTP Port* to `465` + * Set *Connection Security* to `TLS` + * Save the Settings +1. Update File Settings: + * Change *Local Directory Location* from `./data/` to `/opt/mattermost/data` +1. Update Log Settings: + * Set *Log to The Console* to `false` +1. Update Rate Limit Settings: + * Set *Vary By Remote Address* to false + * Set *Vary By HTTP Header* to X-Real-IP +1. Feel free to modify other settings +1. Restart the Mattermost Service by typing: + * ``` sudo restart mattermost``` diff --git a/doc/install/Production-Ubuntu.md b/doc/install/Production-Ubuntu.md index f8fcff978..da3487f45 100644 --- a/doc/install/Production-Ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -34,6 +34,9 @@ * host all all 10.10.10.2/32 md5 1. Reload Postgres database * ```sudo /etc/init.d/postgresql reload``` +1. Attempt to connect with the new created user to verify everything looks good + * ```psql --host=10.10.10.1 --dbname=mattermost --username=mmuser --password``` + * ```mattermost=> \q``` ## Set up Mattermost Server @@ -41,7 +44,7 @@ 1. For the sake of making this guide simple we located the files at `/home/ubuntu/mattermost`. In the future we will give guidance for storing under `/opt`. 1. We have also elected to run the Mattermost Server as the `ubuntu` account for simplicity. We recommend setting up and running the service under a `mattermost` user account with limited permissions. 1. Download the latest Mattermost Server by typing: - * ``` wget https://github.com/mattermost/platform/releases/download/v1.2.1/mattermost.tar.gz``` + * ``` wget https://github.com/mattermost/platform/releases/download/v1.3.0/mattermost.tar.gz``` 1. Unzip the Mattermost Server by typing: * ``` tar -xvzf mattermost.tar.gz``` 1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/mattermost/data`. @@ -62,7 +65,7 @@ * ``` ./platform``` * You should see a console log like `Server is listening on :8065` letting you know the service is running. * Stop the server for now by typing `ctrl-c` -1. Setup Mattermost to use the Ubuntu Upstart daemon which handles supervision of the Mattermost process. +1. Setup Mattermost to use the Upstart daemon which handles supervision of the Mattermost process. * ``` sudo touch /etc/init/mattermost.conf``` * ``` sudo vi /etc/init/mattermost.conf``` * Copy the following lines into `/etc/init/mattermost.conf` @@ -73,7 +76,7 @@ respawn chdir /home/ubuntu/mattermost setuid ubuntu exec bin/platform -``` +``` * You can manage the process by typing: * ``` sudo start mattermost``` * Verify the service is running by typing: @@ -102,7 +105,7 @@ exec bin/platform * Create a configuration for Mattermost * ``` sudo touch /etc/nginx/sites-available/mattermost``` * Below is a sample configuration with the minimum settings required to configure Mattermost - ``` +``` server { server_name mattermost.example.com; location / { @@ -172,8 +175,9 @@ exec bin/platform gzip off; proxy_set_header X-Forwarded-Ssl on; ``` -## Finish Mattermost Server setup + +## Finish Mattermost Server setup 1. Navigate to https://mattermost.example.com and create a team and user. 1. The first user in the system is automatically granted the `system_admin` role, which gives you access to the System Console. 1. From the `town-square` channel click the dropdown and choose the `System Console` option diff --git a/doc/process/release-process.md b/doc/process/release-process.md index 294f5aa79..6e1cf6a77 100644 --- a/doc/process/release-process.md +++ b/doc/process/release-process.md @@ -9,114 +9,148 @@ Notes: - T-minus counts are measured in "working days" (weekdays other than major holidays concurrent in US and Canada) prior to release day. ### (Code complete date of previous release) Beginning of release -- Pre-work for the current release begins at the code complete date of the previous release. See "Code Complete" section below for details. + +Pre-work for the current release begins at the code complete date of the previous release. See "Code Complete" section below for details. ### (T-minus 10 working days) Cut-off for major features -- No pull requests for major features should be submitted to the current release after this date (except if release manager decides to add "release-exception" label) -- (Ops) Post this checklist in Release channel -- (PM) Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) -- (PM) Confirm changes to config.json in compatibility section of Changelog are written back to [settings documentation](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) -- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release -- (Leads) Meets to prioritize the final tickets of the release - - Backlog is reviewed and major features that won’t make it are moved to next release - - Triage tickets - - Finalize roadmap for next release - - Draft roadmap for release after next (used to prioritize design tasks) -- (Marketing) Drafts marketing bullet points for next release based off of roadmap -- (Marketing) Submits pull request for "Highlights" section of the Changelog -- (Marketing) Notes date of announcements in release channel -- (PM) Update [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) for any steps needed to upgrade to new version -- (PM) Prepare tickets for [cutting RC builds](https://mattermost.atlassian.net/browse/PLT-985), [creating the final release candidate](https://mattermost.atlassian.net/browse/PLT-986), [creating AMIs](https://mattermost.atlassian.net/browse/PLT-1213), and [testing GitLab RC with Mattermost](https://mattermost.atlassian.net/browse/PLT-1013) -- (Stand-up) Each team member discusses worst bug (10-15s) +No pull requests for major features should be submitted to the current release after this date (except if release manager decides to add "release-exception" label to Jira ticket). + +1. Logistics: + 1. Post this checklist in Release channel +2. PM: + 1. Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) + - Confirm changes to config.json in compatibility section of Changelog are written back to [settings documentation](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) + - Update [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) for any steps needed to upgrade to new version + - Prepare tickets for [cutting RC builds](https://mattermost.atlassian.net/browse/PLT-985), [creating the final release candidate](https://mattermost.atlassian.net/browse/PLT-986), [creating AMIs](https://mattermost.atlassian.net/browse/PLT-1213), and [testing GitLab RC with Mattermost](https://mattermost.atlassian.net/browse/PLT-1013) +3. Dev: + 1. Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +4. Leads: Meet to prioritize the final tickets of the release
+ 1. Backlog is reviewed and major features that won’t make it are moved to next release + - Triage tickets + - Finalize roadmap for next release + - Draft roadmap for release after next (used to prioritize design tasks) +5. Marketing: + 1. Drafts marketing bullet points for next release based off of roadmap + - Submits pull request for "Highlights" section of the Changelog + - Notes date of announcements in release channel +6. Team: + 1. In Stand-up, each team member discusses worst bug (10-15s) + ### (T-minus 8 working days) Feature Complete and Stabilization -- No pull requests for features can be submitted to the current release after this date (except if release manager add "release-exception" label to Jira ticket) -- (Ops) Post this checklist in Release channel -- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release -- **Stablization** period begins when all features for release have been committed. - - During this period, only **bugs** can be committed to master. Non-bug pull requests are tagged for next version and wait until after a release candidate is cut to be committed to master - - (RM) Exceptions can be made by release manager by setting priority to "Highest" and labelling "release-exception", which will add ticket to [Hotfix list for release candidate](https://mattermost.atlassian.net/issues/?filter=10204). - - (PM) Review all [Severity 1 bugs (data loss or security)](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) to consider for adding to Hotfix list. -- (PM) Complete documentation - - (PM) Make Changelog PR with updates for latest feature additions and changes - - (PM) Make Changelog PR with updates to contributors - - (PM) Make NOTICE.txt PR for any new libraries added from dev, if not added already - - (PM) Prioritize any developer documentation tickets - - (PM) Draft [GitLab ticket](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/942) to take next Mattermost version in the Omnibus, but do not post until RC1 is cut -- (PM) Check testing is complete - - (PM) Works with Ops to check the [Quality Gate](https://github.com/mattermost/process/blob/master/release/quality-gates.md) for feature complete - - (PM + Dev) Sign-off testing of their feature areas (i.e. PM/dev either signs-off that their area is well tested, or they flag that potential quality issues may exist) -- **(Team) Feature Complete Meeting (10:15am PST)** - - (PM) Leads review of Changelog + +**Stablization** period begins when all features for release have been committed. During this period, only **bugs** can be committed to master. Non-bug pull requests are tagged for next version, and are not committed to master until after a release candidate is cut. + +Exceptions can be made by the release manager setting priority to "Highest" and adding a "release-exception" label to the Jira ticket. This will add the ticket to the [hotfix list for release candidate](https://mattermost.atlassian.net/issues/?filter=10204). + +1. Logistics: + 1. Post this checklist in Release channel + - Update the channel header to reflect date + - Mail out mugs to any new contributors +- Dev: + 1. Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +- PM: + 1. Review all [Severity 1 bugs (data loss or security)](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) to consider for adding to Hotfix list + - Update documentation: + 1. Make Changelog PR with updates for latest feature additions, known issues, and contributors + - Make NOTICE.txt PR for any new libraries added from dev, if not added already + - Prioritize any developer documentation tickets + - Draft [GitLab ticket](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/942) to take next Mattermost version in the Omnibus, but do not post until RC1 is cut + - Coordinate testing: + 1. Work with Ops to check the [Quality Gate](https://github.com/mattermost/process/blob/master/release/quality-gates.md) for feature complete + - Receive testing sign-off from feature area owners (i.e. PM/Dev either signs-off that their area is well tested, or flags potential quality issues that may exist) + - Check that Release Candidate Testing Spreadsheet is up to date +- **(Team) Feature Complete Meeting (10:15am PST)**: + 1. (PM) Leads review of Changelog - (Team) Each team member discusses worst bug (10-15s) - (PM) Review feature list for next release - - (Marketing) Share draft of marketing announce for next release -- (Marketing) Communicates checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, -- (Ops) Post Announce Date in Release channel + update the channel header to reflect date -- (Ops) Mail out mugs to any new contributors + - (Marketing) Share draft of marketing bullet points for next release +- Marketing: + 1. Communicate checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, documentation) and begins to write the blog post, tweet, and email for the release announcement ### (T-minus 5 working days) Code Complete and Release Candidate Cut -- (Ops) Post this checklist in Release channel -- (Ops) For the next release, create team meetings on Feature Complete and Code Complete dates -- (PM) Remove "Under Development" notice for current release from Changelog on master + +1. Logistics: + 1. Post this checklist in Release channel + - For the next release, create team meetings on Feature Complete and Code Complete dates +- PM: + 1. Remove "Under Development" notice for current release from Changelog on master + - Assign each area of the release testing spreadsheet to a team member - **(Team) Code Complete Meeting (10:15am PST meeting)** - - (Ops) Walks through each item of this checklist - - (PM) Assigns each area of the release testing spreadsheet to a team member + 1. (Logistics) Walk through each item of this checklist - (Dev) Last check of tickets that need to be merged before RC1 - (Team) Each team member discusses worst bug (10-15s) - **Code Complete** is declared after meeting - - (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release - - (Build) Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the [Release Candidate Checklist](https://github.com/mattermost/process/blob/master/release/create-release-candidate.md) - - (PM) Create meta issue for regressions in GitHub (see [example](https://github.com/mattermost/platform/issues/574)) - - (PM) Include link to meta-issue in release notes of RC1 - - (PM) Tweet announcement that RC1 is ready (see [example](https://twitter.com/mattermosthq/status/664172166368264192)) - - (PM) Submit GitLab ticket to take next Mattermost version in the Omnibus - +- Dev: + 1. Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +- Build: + 1. Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the [Release Candidate Checklist](https://github.com/mattermost/process/blob/master/release/create-release-candidate.md) +- PM: + 1. Create meta issue for regressions in GitHub (see [example](https://github.com/mattermost/platform/issues/574)) + - Include link to meta-issue in release notes of RC1 + - Submit GitLab ticket to take next Mattermost version in the Omnibus +- Marketing: + 1. Tweet announcement that RC1 is ready (see [example](https://twitter.com/mattermosthq/status/664172166368264192)) + ### (T-minus 4 working days) Release Candidate Testing -- (Team) Final testing is conducted by the team on the acceptance server and any issues found are filed -- (Build) Tests upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) - - Database upgrade should be tested on both MySQL and Postgres - - (Ops) Posts copy of the **Release Candidate Testing** checklist into Town Square in PRODUCTION - - (Ops) Moves meeting, test and community channels over to the production version of RC, and posts in Town Square asking everyone to move communication over to the new team for testing purposes - - (PM) Test feature areas and post bugs to Bugs/Issues in PRODUCTION - - (Ops) Runs through general testing checklist on RC1 and post bugs to Bugs/Issues in PRODUCTION - - (PM & DEV) Add **#p1** tag to any “Blocking” issue that looks like a hotfix to the RC is needed, and create a public ticket in Jira. Blocking issues are considered to be security issues, data loss issues, issues that break core functionality, or significantly impact aesthetics. -- (PM) Updates the GitHub meta issue - - (PM) Posts links to all issues found in RC as comments on the meta issue - - (PM) Updates description to include approved fixes - - (PM) Posts screenshot and link to final tickets for next RC to the Release room - - (PM) Updates Release Notes with any new issues that will not be fixed for the current version -- (PM & DEV leads) Triage hotfix candidates and decide on whether and when to cut next RC or final -- (Dev) PRs for hotfixes made to release branch, and changes from release branch are merged into master - - (Ops) Tests approved fixes on master - - (Dev) Pushes next RC to acceptance after testing is complete and approved fixes merged -- (Dev) pushes next RC to acceptance and announces in Town Square on PRODUCTION - - (PM) closes the meta issue after the next RC is cut, and opens another ticket for new RC -- (Ops) verifies each of the issues in meta ticket is fixed - - (PM) If no blocking issues are found, PM, Dev and Ops signs off on the release +1. Logistics: + 1. Post this checklist in Release channel + - Queue an agenda item for next team meeting for Release Process Kaizen/Q&A +- Build: + 1. Test upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) + - Database upgrade should be tested on both MySQL and Postgres +- Team: + 1. Test assigned areas of the Release Candidate Testing Spreadsheet and file any bugs found in Jira + - Post a link to any "Blocking" issue that may need a hotfix to the RC in the Release room, with the **#p1** tag. If the issue is security related or contains confidential information, post the link in the Confidential Bugs private group. Blocking issues are considered to be security issues, data loss issues, issues that break core functionality, or significantly impact aesthetics. + - Triage hotfix candidates and decide on whether and when to cut next RC or final + - If no blocking issues are found, PM, Dev and Ops signs off on the release +- PM: + 1. Post links to all issues found in RC as comments on the meta issue + - Update the meta issue description to include approved fixes + - Post screenshot and link to final tickets for next RC to the Release room + - Update Changelog “Known Issues” section with any significant issues that were found and not fixed for the final release +- Dev: + 1. PRs for hotfixes made to release branch, and changes from release branch are merged into master +- Logistics: + 1. For potentially destabilizing changes, test approved fixes on a spinmint private build +- Build: + 1. Push next RC to acceptance after testing is complete and approved fixes merged, announces in Town Square on pre-release.mattermost.com/core +- PM: + 1. Closes the meta issue after the next RC is cut, and opens another ticket for new RC +- Ops: + 1. Verifies each of the issues in meta ticket is fixed + ### (T-minus 2 working days) Release Build Cut -- (Ops) Post this checklist in Release channel -- (Build) Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC - - (PM) Any significant issues that were found and not fixed for the final release are noted in the release notes - - If an urgent and important issue needs to be addressed between major releases, a bug fix release (e.g. 1.1.1) may be created -- (PM) Copy and paste the Release Notes from the Changelog to the Release Description -- (PM) Update the mattermost.org/download page -- (PM) Update the AMI links on mattermost.org/installation -- (PM) Close final GitHub RC meta ticket -- (Dev) Delete RCs after final version is shipped -- (Marketing) Finalize marketing - - (Marketing) Finalize mailchimp email blast - - (Marketing) Finalize blog post and put on timer for release - - (Marketing) Finalize tweet announcement - - (Marketing) Finalize announcement on general mailing list - - (Marketing) Finalize announcement for gitlab.mattermost.com - + +The final release is cut. If an urgent and important issue needs to be addressed between major releases, a bug fix release (e.g. 1.1.1) may be created + +1. Logistics: + 1. Post this checklist in Release channel +- Build: + 1. Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC + - Delete RCs after final version is shipped +- PM: + 1. Copy and paste the Release Notes from the Changelog to the Release Description + - Update the mattermost.org/download page + - Update the AMI links on mattermost.org/download and mattermost.org/installation + - Close final GitHub RC meta ticket +- Marketing: + 1. Finalize mailchimp email blast + - Finalize blog post and put on timer for release + - Finalize tweet announcement + - Finalize announcement on general mailing list + - Finalize announcement for gitlab.mattermost.com + ### (T-minus 0 working days) Release Day -- (Ops) Post this checklist in Release channel -- (PM) Confirm marketing has been posted (animated GIFs, screenshots, mail announcement, Tweets, blog posts) -- (PM) Close the release in Jira -- (PM) Set header of next release as UNDER DEVELOPMENT in CHANGELOG on master -- (Dev) Check if any libraries need to be updated for the next release, and if so bring up in weekly team meeting -- (Ops) Post key dates for the next release in the header of the Release channel -- (Ops) Queue an agenda item for next team meeting for Release Process Kaizen/Q&A + +1. Logistics: + 1. Post this checklist in Release channel + - Post key dates for the next release in the header of the Release channel +- PM: + 1. Close the release in Jira + - Set header of next release as UNDER DEVELOPMENT in CHANGELOG on master +- Dev: + 1. Check if any libraries need to be updated for the next release, and if so bring up in weekly team meeting +- Marketing: + 1. Confirm marketing has been posted (animated GIFs, screenshots, mail announcement, tweets, blog posts) |