Merge pull request #2549 from wireapp/fs-698/classified-domains

Fs 698/classified domains

docs/src/how-to/install/configuration-options.rst

@@ -887,4 +887,54 @@ To change the TeamSearchVisibilityInbound to SearchableByOwnTeam for the team ru
 
   curl -XPUT -H 'Content-Type: application/json' -d "{\"status\": \"disabled\"}" http://localhost:9000/i/teams/dcbedf9a-af2a-4f43-9fd5-525953a919e1/features/searchVisibilityInbound
 
- 
+ 
+
+Configuring classified domains
+------------------------------
+
+As a backend administrator, if you want to control which other backends (identified by their domain) are "classified", 
+
+change the following `galley` configuration in the `value.yaml.gotmpl` file of the wire-server chart:
+
+.. code:: yaml 
+
+    galley:
+      replicaCount: 1
+      config:
+      ...
+        featureFlags:
+        ...
+          classifiedDomains: 
+            status: enabled
+            config:
+              domains: ["domain-that-is-classified.link"]
+              ...
+
+This is not only a `backend` configuration, but also a `team` configuration/feature.
+
+This means that different combinations of configurations will have different results.
+
+Here is a table to navigate the possible configurations:
+
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Backend Config enabled/disabled  | Backend Config Domains                      | Team Config enabled/disabled  | Team Config Domains    | User's view                     |
++==================================+=============================================+===============================+========================+=================================+
+| Enabled                          | [domain1.example.com]                       | Not configured                | Not configured         | Enabled, [domain1.example.com]  |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Enabled                          | [domain1.example.com][domain1.example.com]  | Enabled                       | Not configured         | Enabled, [domain1.example.com]  |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Enabled                          | [domain1.example.com]                       | Enabled                       | [domain2.example.com]  | Enabled, Undefined              |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Enabled                          | [domain1.example.com]                       | Disabled                      | Anything               | Undefined                       |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Disabled                         | Anything                                    | Not configured                | Not configured         | Disabled, no domains            |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+| Disabled                         | Anything                                    | Enabled                       | [domain2.example.com]  | Undefined                       |
++----------------------------------+---------------------------------------------+-------------------------------+------------------------+---------------------------------+
+
+The table assumes the following:
+
+* When backend level config says that this feature is enabled, it is illegal to not specify domains at the backend level.
+* When backend level config says that this feature is disabled, the list of domains is ignored.
+* When team level feature is disabled, the accompanying domains are ignored.
+