Skip to content

Commit 4cd3d33

Browse files
committed
Initial Restructure - Deployment Section
1 parent 6dea196 commit 4cd3d33

File tree

62 files changed

+486
-222
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+486
-222
lines changed

source/_templates/custom-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ <h4>Admin guide</h4>
214214
</section>
215215

216216
<section class='masthead-cards-section'>
217-
<h2 class='masthead-h2'>Use Mattermost</h2>
217+
<h2 class='masthead-h2'>User Guide</h2>
218218
<div class='masthead-cards'>
219219
<a
220220
href='guides/collaborate.html'

source/deploy/architecture.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Bleve search (experimental)
2+
===========================
3+
4+
.. include:: ../_static/badges/allplans-selfhosted.rst
5+
:start-after: :nosearch:
6+
7+
Bleve is a search engine that uses Lucene-style full-text search and indexing. This style of search and indexing helps overcome limitations of the default database search such as challenges with characters and advanced search capabilities.
8+
9+
The Bleve search engine works as a library integrated into the Mattermost codebase. As it generates indexes in the filesystem of the server that it is running on, it doesn’t require an external server to function. Because of this, Bleve should not be enabled in High Availability deployments.
10+
11+
.. note::
12+
13+
Bleve search uses the scorch index type on newly-created indexes. This new index type features efficiency improvements and indexes that use significantly less disk space. Go to **System Console > Experimental > Bleve** and select **Purge Index** to run a purge operation. When that's complete, select **Index Now** to reindex. Bleve remains compatible with existing indexes, so currently indexed data will continue to work if a purge and reindex isn't run.
14+
15+
Configuring Bleve in Mattermost
16+
-------------------------------
17+
18+
Follow these steps to configure the Mattermost server to use Bleve and generate required indexes. Once the configuration is saved, new posts made to the database will be automatically indexed with Bleve.
19+
20+
**Note:** During indexing, search results may be incomplete until the indexing job is complete.
21+
22+
1. Open **System Console > Experimental > Bleve**.
23+
2. Set **Enable Bleve Indexing** to **true** to enable the other settings on the page.
24+
3. Set the directory path to use for storing Bleve indexes (e.g.: ``/var/opt/mattermost/bleveindexes``). The user running Mattermost should have permissions to access the directory. See our :ref:`configuration settings <configure/experimental-configuration-settings:experimental bleve configuration settings>` documentation for details.
25+
4. Save the configuration.
26+
5. Select **Index Now**. All users, channels, and posts in the database will be indexed oldest to newest.
27+
6. Set **Enable Bleve for search queries** to **true**.
28+
7. Set **Enable Bleve for autocomplete queries** to **true**.
29+
30+
.. note::
31+
32+
Search results for files shared before upgrading to Mattermost Server v5.35 may be incomplete until an extraction command is run using the :ref:`mmctl <manage/mmctl-command-line-tool:mmctl extract>`. After running this command, the search index must be rebuilt. Go to **System Console > Experimental > Bleve > Bulk Indexing**, then select **Index Now** to rebuild the search index to include older file contents.
33+
34+
Using Bleve search
35+
------------------
36+
37+
The following conditions are applied when using Bleve search:
38+
39+
* **Unquoted terms:** Search terms that contain non-alphanumeric characters/special characters outside of quotation marks are removed. For example, using ``abcd "**" && abc`` as a search term will return results for a search for ``abcd "**" abc`` as the ``&&`` characters weren't within the quotation marks.
40+
* **Wildcard search:** Wildcard search (e.g., ``abc*``) is supported.
41+
42+
How does search work with Bleve disabled?
43+
-------------------------------------------
44+
45+
Mattermost performs full text searches against the database unless you have an :ref:`Enterprise license <about/editions-and-offerings:mattermost enterprise edition>` and :doc:`Elasticsearch </scale/elasticsearch>` configured.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

source/deploy/desktop/overview.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Desktop App Deployment
2+
=====================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
:hidden:
7+
:titlesonly:
8+
9+
desktop-app
10+
desktop-msi-installer-and-group-policy-install
11+
desktop-app-managed-resources
12+
desktop-custom-dictionaries
13+
14+
This documentation provides guidance on deploying and managing the Mattermost Desktop application across your organization.
15+
16+
The Mattermost desktop application is available for Windows, macOS, and Linux operating systems. Learn about installation, configuration, and management options for deploying the desktop app in your environment.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)