[sr-dev] git:master:628d2d3f: modules: readme files regenerated - topos ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 628d2d3fa7a6b61c85f0211838640bc5713ba3e7
URL: https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc5713ba3e7

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-09-15T07:46:18+02:00

modules: readme files regenerated - topos ... [skip ci]

---

Modified: src/modules/topos/README

---

Diff:  https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc5713ba3e7.diff
Patch: https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc5713ba3e7.patch

---

diff --git a/src/modules/topos/README b/src/modules/topos/README
index b70fdd3737..72b1ae8b3f 100644
--- a/src/modules/topos/README
+++ b/src/modules/topos/README
@@ -98,17 +98,21 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module offers topology hiding by stripping the SIP routing headers
-   that show topology details. The script interpreter gets the SIP
-   messages with full content, so all existing functionality is preserved.
+   This module offers topology hiding for INVITE-based dialogs, by
+   stripping the SIP routing headers that show topology details . The
+   script interpreter gets the SIP messages with full content, so all
+   existing functionality is preserved.
 
    The module is transparent for the configuration writer. It only needs
-   to be loaded (tune the parameters if needed).
+   to be loaded (tune the module parameters if needed).
 
    It also works for SIP MESSAGE or other requests that do not create a
-   call dialog -- record_route() must be used for them as well, the
-   headers are not going to be in the messages sent to the network, they
-   are needed to know local addresses used to communicate with each side.
+   dialog -- record_route() must be used for them as well, the headers are
+   not going to be in the messages sent to the network, they are needed to
+   know local addresses used to communicate with each side. At this moment
+   it is not designed to work for presence (SUBSCRIBE-based) dialogs. The
+   REGISTER and PUBLISH requests are skipped from processing by this
+   module, expected to be terminated on a local SIP server.
 
 2. Dependencies