Rewrote README documentation

playbooks/linux/ubuntu-server/nextcloud_full_deployment/README.txt

@@ -1,43 +1,99 @@
 ---- Welcome ----
 
-This is a full-stack Nextcloud deployment combined with a hardnening and a Collabora CODE server setup and integration into Nextcloud.
+This is a full-stack Nextcloud deployment combined with hardening, a Collabora CODE server for
+in-browser document editing, and a Nextcloud Talk High-Performance Backend (HPB) for group calls.
+An Open-Xchange mail connector is also planned (see "Playbooks" below for its current status).
 
 The minimum setup of this deployment would be a single server (this context wasn't tested yet).
-The optimal setup would be two servers, a server for the Nextcloud and a server for the CODE server.
+The optimal setup uses one server per role:
 
-The current playbook stack is made for a theoratical infinite amount of Nextcloud instance setups (not load balanced or anything in that direction) and a single server for Collabora CODE.
+    - Nextcloud                    (Apache + PHP + MariaDB)
+    - Collabora CODE               (document editing backend)
+    - Nextcloud Talk HPB           (NATS + Janus Gateway + signaling server, via Docker)
 
-Currently this setup assumes that the server for both Nextcloud and Collabora CODE is Ubuntu 26.04 server. This can be changed but hasn't been tested yet and required some tinkering (e.g. in the deploy_collabora_code.yml file for the APT sources).
+The current playbook stack is made for a theoretical infinite amount of Nextcloud instance setups
+(not load balanced or anything in that direction) and a single server each for Collabora CODE and
+the Talk HPB.
+
+Currently this setup assumes that every server is Ubuntu 24.04 server. This can be changed but
+hasn't been tested yet and requires some tinkering (e.g. in the deploy_collabora_code.yml file for
+the APT sources).
+
+---- Directory structure ----
+
+    /nextcloud_full_deployment
+    | - README.txt                             (this file)
+    | - deploy_hardened_nextcloud.yml
+    | - deploy_collabora_code.yml
+    | - connect_nextcloud_collabora.yml
+    | - deploy_nc_talk_hpb.yml
+    | - connect_nextcloud_open-xchange.yml
+    | - /inventory
+        | - hosts.ini
+    | - /vars
+        | - shared_vars.yml.example
+
+---- Requirements ----
+
+On the Ansible control node:
+    - Ansible collections: community.general, community.mysql, community.docker
+
+On every managed host:
+    - Ubuntu 24.04 server (see note above about other versions)
+    - User with sudo rights, reachable over SSH
 
 ---- Quickstart ----
 
 First of all specify your hosts in the inventory folder.
-Please also add the username and password as host vars in the two inventory files.
+Please also add the username and password as host vars in the inventory file.
 
     /nextcloud_full_deployment
     | - /inventory
         | - hosts.ini
 
-After that is done go change all the variables that will be used in the setup according to your needs.
+The inventory has one host group per role: [nextcloud], [collabora_code] and
+[nextcloud_talk_hpb]. A single host can be a member of more than one group if you want to
+co-locate roles on one server.
+
+After that is done, copy vars/shared_vars.yml.example to vars/shared_vars.yml and go change all
+the variables in it according to your needs. Every secret in that file (database password, admin
+password, Collabora admin password, Talk HPB signaling/TURN/hash/block secrets) ships with a
+"ChangeMe..." placeholder - replace all of them before deploying.
 
     /nextcloud_full_deployment
     | - vars
         | - shared_vars.yml
 
-When you are done with preparing your deployment, you can start the deployment.
+When you are done preparing your deployment, you can start it. Run the playbooks against hosts in
+this order, since each one depends on the previous:
 
-The basic Nextcloud deployment is done by running:
-ansible-playbook deploy_hardened_nextcloud.yml -i inventory --ask-become-pass
+1. Nextcloud itself (Apache, PHP, MariaDB, TLS, hardening, fail2ban):
+   ansible-playbook deploy_hardened_nextcloud.yml -i inventory --ask-become-pass
 
-Collabora CODE is deployed with:
-ansible-playbook deploy_collabora_code.yml -i inventory --ask-become-pass
+2. Collabora CODE (document editing backend):
+   ansible-playbook deploy_collabora_code.yml -i inventory --ask-become-pass
 
-To connect Collabora CODE and your Nextcloud instances use:
-ansible-playbook connect_nextcloud_collabora.yml -i inventory --ask-become-pass
+3. Connect Collabora CODE to your Nextcloud instance(s):
+   ansible-playbook connect_nextcloud_collabora.yml -i inventory --ask-become-pass
 
+4. Nextcloud Talk High-Performance Backend (NATS + Janus + signaling server, via Docker):
+   ansible-playbook deploy_nc_talk_hpb.yml -i inventory --ask-become-pass
 
-You can debug all the playbooks by using this commmand.
+   This playbook only sets up the backend itself. Nextcloud does not pick it up automatically -
+   finish the connection by hand on each Nextcloud instance under
+   Administration -> Talk -> High-performance backend:
+       Signaling server URL: https://<nc_talk_hpb_domain>/standalone-signaling
+       Shared secret:        nc_talk_hpb_signaling_secret (from shared_vars.yml)
+       TURN server:          <nc_talk_hpb_domain>:3478, protocols UDP and TCP
+       TURN secret:          nc_talk_hpb_turn_secret (from shared_vars.yml)
+
+5. Open-Xchange mail connector - not yet implemented. connect_nextcloud_open-xchange.yml
+   currently only contains the sudo-rs workaround boilerplate shared by every playbook in this
+   repo; the openxchange_* variables in shared_vars.yml.example are reserved for it but are not
+   consumed by any task yet.
+
+You can debug all the playbooks by using this command.
 ansible-playbook <playbook_file.yml> -i inventory --ask-become-pass -vv
 
 
-# This file was written by Ebbe Baß (umpi) - ebbe@ping-mee.de
+# This file was written by Ebbe Baß (umpi) - ebbe@ping-mee.de