-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
198 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,6 +79,7 @@ Modules | |
pop3_proxy | ||
pop3_connector | ||
chat | ||
team_chat | ||
ups | ||
fax_server | ||
firewall | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
.. _team_chat-section: | ||
|
||
====================== | ||
Team chat (Mattermost) | ||
====================== | ||
|
||
The :index:`team chat` module installs Mattermost Team Edition platform inside |product|. | ||
|
||
Mattermost is an Open Source, private cloud :index:`Slack`-alternative. Check out the excellent official documentation: https://docs.mattermost.com/. | ||
|
||
Configuration | ||
============= | ||
|
||
Mattermost installation needs a dedicated virtual host, an FQDN like ``chat.nethserver.org``. | ||
|
||
Before proceeding with the configuration, make sure to create the corresponding DNS record. If |product| act as the DNS server of your LAN, please refer to :ref:`dns-section`. | ||
|
||
If your server is using a Let's Encrypt certificate as default, make also sure to have a corresponding public DNS record. See :ref:`server_certificate-section` for more info. | ||
|
||
How to configure: | ||
|
||
1. Access :guilabel:`Team chat` page inside the Server Manager | ||
2. Check :guilabel:`Enable Mattermost Team Edition`, then enter a valid FQDN inside :guilabel:`Virtual host name` field (eg. ``chat.nethserver.org``) | ||
3. Open the entered host name inside the browser, eg: ``https://chat.nethserver.org``. | ||
At first access, a wizard will create the administrator user | ||
|
||
The following features are enabled by default: | ||
|
||
- mail notifications | ||
- push notifications for mobile apps | ||
- redirect from HTTP to HTTPS | ||
|
||
|
||
Authentication | ||
============== | ||
|
||
Mattermost authentication is *not* integrated with any Account Provider. | ||
The Mattermost administrator should take care of users and teams creation. | ||
To ease this task, the system administrator can use the :guilabel:`Import users` button.. | ||
|
||
The command will: | ||
|
||
- create a default team named as the Company from :ref:`organization_contacts-section` | ||
- read all users from local or remote Account Providers and create them inside Mattermost | ||
|
||
Please note that: | ||
|
||
- users disabled in the Server Manager, or already existing in Mattermost, will be skipped | ||
- a random password will be generated for each user | ||
|
||
.. note:: | ||
|
||
Users are not automatically synced inside Mattermost. | ||
Each time a user is created or removed, remember to execute ``mattermost-bulk-user-create`` command or | ||
manually create the user using Mattermost administration web interface. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
===================== | ||
nethserver-mattermost | ||
===================== | ||
|
||
Stack: | ||
|
||
- Mattermost | ||
- PostgreSQL 9.4 listening on non-standard port 55432 | ||
- Apache as proxy server | ||
|
||
Apache configuration derived from: https://github.com/mattermost/docs/issues/1114 | ||
|
||
|
||
First configuration | ||
=================== | ||
|
||
Mattermost requires a dedicated virtualhost and it's accessibile only from HTTPS. | ||
|
||
To start Mattermost, execute: | ||
|
||
:: | ||
|
||
config setprop mattermost VirtualHost mattermost.yourdomain.com status enabled | ||
signal-event nethserver-mattermost-update | ||
|
||
Then, access ``https://mattermost.yourdomain.com`` and perform the first configuration. | ||
|
||
|
||
Database | ||
======== | ||
|
||
Properties: | ||
|
||
- ``TCPPort``: Mattermost listen port, change only for development purpose | ||
- ``VirtualHost``: dedicated FQDN for virtual host | ||
- ``status``: can be ``enabled`` or ``disabled``, default to ``disabled`` | ||
- ``access``: firewall access, leave blank or at least set to ``none`` | ||
|
||
Example: :: | ||
|
||
mattermost=service | ||
TCPPort=5432 | ||
VirtualHost=mattermost.local.neth.eu | ||
access= | ||
status=enabled | ||
|
||
Account synchronization | ||
======================= | ||
|
||
The ``mattermost-bulk-user-create`` command will: | ||
|
||
- create a default team named as the ``Company`` from ``OrganizationContact`` | ||
- read all users from local or remote Account Providers and create them inside Mattermost | ||
|
||
Please note that: | ||
|
||
- users disabled in the Server Manager or already existing in Mattermost will be skipped | ||
- a random password will be generated for each user | ||
|
||
Forcing a common default password | ||
--------------------------------- | ||
|
||
It's possible to set a default password for each new Mattermost user, just append the default | ||
password to command invocation. | ||
|
||
Example: :: | ||
|
||
mattermost-bulk-user-create Password,1234 | ||
|