diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/help/Search.md | 12 | ||||
| -rw-r--r-- | doc/help/Team-Statistics.md | 24 | ||||
| -rw-r--r-- | doc/install/Upgrade-Guide.md | 53 |
3 files changed, 72 insertions, 17 deletions
diff --git a/doc/help/Search.md b/doc/help/Search.md index 02ecf7d40..51095aac6 100644 --- a/doc/help/Search.md +++ b/doc/help/Search.md @@ -2,14 +2,16 @@ The search box in Mattermost brings back results from any channel of which you’re a member. No results are returned from channels where you are not a member - even if they are open channels. -Some things to know about search: +#### Some things to know about search: - Multiple search terms are connected with “OR” by default. Typing in `Mattermost website` returns results containing “Mattermost” or “website” -- You can use quotes to return search results for exact terms, like `"Mattermost website"` will only return messages containing the entire phrase `"Mattermost website"` and not return messages with only `Mattermost` or `website` -- You can use the `*` character for wildcard searches that match within words. For example: Searching for `rea*` brings back messages containing `reach`, `reason` and other words starting with `rea`. +- Use `from:` to find posts from specific users and `in:` to find posts in specific channels. For example: Searching `Mattermost in:town-square` only returns messages in Town Square that contain `Mattermost` +- Use quotes to return search results for exact terms. For example: Searching `"Mattermost website"` returns messages containing the entire phrase `"Mattermost website"` and not messages containing only `Mattermost` or `website` +- Use the `*` character for wildcard searches that match within words. For example: Searching for `rea*` brings back messages containing `reach`, `reason` and other words starting with `rea`. -#### Limitations +#### Limitations: - Search in Mattermost uses the full text search features included in either a MySQL or Postgres database, which has some limitations - Special cases that are not supported in default full text search, such as searching for IP addresses like `10.100.200.101`, can be added in future as the search feature evolves - - Searches with fewer than three characters will return no results, so for searching in Chinese try adding * to the end of queries + - Two letter searches and common words like "this", "a" and "is" won't appear in search results + - For searching in Chinese try adding * to the end of queries diff --git a/doc/help/Team-Statistics.md b/doc/help/Team-Statistics.md new file mode 100644 index 000000000..05d63794b --- /dev/null +++ b/doc/help/Team-Statistics.md @@ -0,0 +1,24 @@ +## Team Statistics +___ +Statistics on users, posts and channels are tracked for each team and viewable in the System Console. System Administrators can access statistics for your Mattermost teams by clicking the **three-dot menu**, then click **System Console**. Under the *Teams* section on the left side you’ll see a list of the teams that belong to your domain. Click **Statistics** under the team of interest to open the stats page. Here is some helpful terminology: + +**Total Users** +The total number of accounts created, regardless of if the accounts are active or inactive. + +**Total Posts** +The total number of posts made by your team, including deleted posts or those made by incoming and outgoing webhook integrations. + +**Public Groups** +The number of public channels created by your team, including channels that may have been archived. + +**Private Group** +The number of private groups created by your team, including groups that may have been archived. + +**Active Users With Posts** +Users who logged in and made a post on a certain day. + +**Recently Active Users** +Users that have logged in and had recent browser activity in Mattermost. + +**Newly Created Users** +Users that have recently completed the signup process to create a Mattermost account on the team. diff --git a/doc/install/Upgrade-Guide.md b/doc/install/Upgrade-Guide.md index fc3a0711f..7f4eeaeb9 100644 --- a/doc/install/Upgrade-Guide.md +++ b/doc/install/Upgrade-Guide.md @@ -1,19 +1,53 @@ # Mattermost Upgrade Guide -### Upgrading Mattermost in GitLab 8.0 to GitLab 8.1 with omnibus +### Upgrading Mattermost to Next Major Release + +Each release of Mattermost contains logic to upgrade it from the previously major build version. For example, version 1.2 upgrades the database and configuration data schema for a Mattermost version 1.1 server. The following procedure outlines how to upgrade Mattermost to the next major release version. + +1. Download the **next major build release** of your server + 1. Determine the current version of your Mattermost server + 1. Go to any team site, opening the main menu at the top right of the left-hand sidebar and selecting **About Mattermost** + 2. Identify the next major build release of your Mattermost server from the list of [stable Mattermost releases](https://github.com/mattermost/platform/releases) + 1. For example, if your current version is 1.1.0, you want to select version 1.2.0. + 1. In some cases there will be **minor build releases**, such as 1.2.1 and 1.2.2. The minor build number indicates a bug fix or security issue release. Testing on minor build versions is less extensive than on major build versions and it is recommended that you use the minor build only if you need the specific additions included. + 3. Review Release Notes + 1. Check the release notes for the version of Mattermost you are able to install, and note any setting changes in the **Compatibility** section that apply to your deployment + 4. Download the `mattermost.tar.gz` file with the correct version for your upgrade + 1. You can use `wget` to retrieve a specific version. For example, to download v1.1.0 run `wget https://github.com/mattermost/platform/releases/download/v1.1.0/mattermost.tar.gz` +2. Stop the Mattermost Server + 1. As best practice, consider posting to the Town Square channel of active teams pre-announcing the scheduled downtime to apply these upgrade procedures + 2. To stop the server run `sudo stop mattermost` +2. Backup your data + 1. Back up your `config.json` file, which contains your system configuration. This will be used to restore your current settings after the new version is installed + 2. Backup your database using your organization's standard procedures for backing up MySQL or PostgreSQL + 3. If you're using local file storage, back up the location where files are stored +4. Decompress `mattermost.tar.gz` and use its contents to replace the current version of Mattermost on disk + 1. Run `tar -xvzf mattermost.tar.gz` +5. Restore the state of your server by copying the backed up version of `config.json` in place of the default `config.json` +6. Start your server and address any setting changes relevant in the latest version of Mattermost + 1. Run `sudo start mattermost` + 2. The server will upgrade your database schema to be compatibile with the new release, as well as upgrade your `config.json` file to the latest format, using default values for new settings added + 3. Go to the System Console to update any settings that have been added or modified based on the **Compatibility** documentation in the release notes +7. Test the system is working by going to the URL of an existing team + +### Upgrading from Mattermost Beta (Version 0.7) + +The following instructions apply to updating installations of Mattermost v0.7-Beta to Mattermost 1.1. + +#### Upgrading Mattermost in GitLab 8.0 to GitLab 8.1 with omnibus Mattermost 0.7.1-beta in GitLab 8.0 was a pre-release of Mattermost and Mattermost v1.1.1 in GitLab 8.1 was [updated significantly](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#configjson-changes-from-v07-to-v10) to get to a stable, forwards-compatible platform for Mattermost. The Mattermost team didn't think it made sense for GitLab omnibus to attempt an automated re-configuration of Mattermost (since 0.7.1-beta was a pre-release) given the scale of change, so we're providing instructions for GitLab users who have customized their Mattermost deployments in 8.0 to move to 8.1: -1. Follow the [Upgrading Mattermost v0.7.1-beta to v1.1.1 instructions](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md#upgrading-mattermost-v071-beta-to-v111) below to identify the settings in Mattermost's `config.json` file that differ from defaults and need to be updated from GitLab 8.0 to 8.1. +1. Follow the [Upgrading Mattermost v0.7.1-beta to v1.1.1 instructions](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md#upgrading-mattermost-v071-beta-to-v111) below to identify the settings in Mattermost's `config.json` file that differ from defaults and need to be updated from GitLab 8.0 to 8.1 2. Upgrade to GitLab 8.1 using omnibus, and allowing it overwrite `config.json` to the new Mattermost v1.1.1 format -3. Manually update `config.json` to new settings identified in Step 1. +3. Manually update `config.json` to new settings identified in Step 1 -Optionally, you can use the new [System Console user interface](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) to make changes to your new `config.json` file. +Optionally, you can use the new [System Console user interface](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) to make changes to your new `config.json` file. -### Upgrading Mattermost v0.7.1-beta to v1.1.1 +#### Upgrading Mattermost v0.7.1-beta to v1.1.1 _Note: [Mattermost v1.1.1](https://github.com/mattermost/platform/releases/tag/v1.1.1) is a special release of Mattermost v1.1 that upgrades the database to Mattermost v1.1 from EITHER Mattermost v0.7 or Mattermost v1.0. The following instructions are for upgrading from Mattermost v0.7.1-beta to v1.1.1 and skipping the upgrade to Mattermost v1.0._ @@ -23,11 +57,6 @@ If you've manually changed Mattermost v0.7.1-beta configuration by updating the 2. For each setting that you changed, check [the changelog documentation](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#configjson-changes-from-v07-to-v10) on whether the configuration setting has changed between v0.7 and v1.1.1 -3. Update your new [`config.json` file in Mattermost v1.1](https://github.com/mattermost/platform/blob/v1.1.0/config/config.json), based on your preferences and the changelog documentation above. - -Optionally, you can use the new [System Console user interface](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) to make changes to your new `config.json` file. - - - - +3. Update your new [`config.json` file in Mattermost v1.1](https://github.com/mattermost/platform/blob/v1.1.0/config/config.json), based on your preferences and the changelog documentation above +Optionally, you can use the new [System Console user interface](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) to make changes to your new `config.json` file. |