From f3bc5d0163991da70ea46e3c2f5c8ffcc9c81cd7 Mon Sep 17 00:00:00 2001
From: tavo-wasd <gustavo@gustavocalvo.xyz>
Date: Sat, 3 Feb 2024 22:41:41 -0600
Subject: [PATCH] readme

---
 self_hosting/services/collabora/README.md | 68 +++++++++++++++++++++--
 1 file changed, 64 insertions(+), 4 deletions(-)

diff --git a/self_hosting/services/collabora/README.md b/self_hosting/services/collabora/README.md
index b50059d..a025477 100644
--- a/self_hosting/services/collabora/README.md
+++ b/self_hosting/services/collabora/README.md
@@ -19,18 +19,29 @@ apt update
 
 ## Install packages
 
+Firstly, install Microsoft fonts such as Arial, Times, etc. (optional)
+Collabora's installation will look for system fonts and generate a
+systemplate, so, this will ensure MS fonts are available in collabora.
+
 ```shell
 apt install ttf-mscorefonts-installer
 ```
 
+Install Collabora front and backend packages, plus spell checking
+
 ```shell
 apt install coolwsd code-brand hunspell collaboraoffice*-dict-*
 ```
 
+## Configure nginx
+
+Add to `/etc/nginx/sites-available/collabora.conf`
+(change office.example.org with your domain):
+
 ```nginx
 server {
     listen 80;
-    server_name office.tavo.one;
+    server_name office.example.org;
 
     # static files
     location ^~ /browser {
@@ -76,12 +87,61 @@ server {
 }
 ```
 
+Enable nginx site.
 
-Edit ``/etc/nginx/sites-available/collabora.conf`` for languages and SSL
+```
+ln -s /etc/nginx/sites-available/collabora.conf /etc/nginx/sites-enabled/
+```
 
-## certbot
+Run this and select your domain.
 
-## Enable
+```
+certbot --nginx
+```
+
+Restart nginx to apply
+
+```
+systemctl restart nginx
+```
+
+## Edit ``/etc/coolwsd/coolwsd.xml``
+
+### Languages
+
+Add or remove languages, for example, here I set only `es_ES en_US de_DE fr_FR`.
+This can impact performance, aim for few languages.
+
+```xml
+...
+<allowed_languages desc="List of supported languages of Writing Aids (spell checker, grammar checker, thesaurus, hyphenation) on this instance. Allowing too many has negative effect on startup performance." default="de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru">es_ES en_US de_DE fr_FR</allowed_languages>
+...
+```
+
+### SSL Termination
+
+Configure SSL using reverse proxy, secure and fast.
+
+Here I set SSL to false:
+
+```
+...
+<ssl desc="SSL settings">
+        <!-- switches from https:// + wss:// to http:// + ws:// -->
+        <enable type="bool" desc="Controls whether SSL encryption between coolwsd and the network is enabled (do not disable for production deployment). If default is false, must first be compiled with SSL support to enable." default="true">false</enable> 
+...
+```
+
+Here I set termination to true:
+
+```
+...
+<!-- SSL off-load can be done in a proxy, if so disable SSL, and enable termination below in production -->
+<termination desc="Connection via proxy where coolwsd acts as working via https, but actually uses http." type="bool" default="true">true</termination>
+...
+```
+
+## Enable coolwsd
 
 ```shell
 systemctl enable --now coolwsd