Skip to content

Commit 1bcd887

Browse files
committed
update docs
1 parent 37f1eec commit 1bcd887

1 file changed

Lines changed: 5 additions & 18 deletions

File tree

docs/source/pubsub.rst

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -116,24 +116,6 @@ Example directive:
116116
# sasl_security_protocol: SASL_PLAINTEXT # default SASL_PLAINTEXT
117117
hidden: true # default false
118118
119-
.. note::
120-
121-
For any Pub/Sub endpoints requiring authentication, encode the ``url`` value as follows:
122-
123-
* ``mqtt://username:password@localhost:1883``
124-
* ``https://username:password@localhost``
125-
126-
As with any section of the pygeoapi configuration, environment variables may be used as needed, for example
127-
to set username/password information in a URL. If ``pubsub.broker.url`` contains authentication, and
128-
``pubsub.broker.hidden`` is ``false``, the authentication information will be stripped from the URL
129-
before displaying it on the landing page.
130-
131-
.. note::
132-
133-
If a ``channel`` is defined, it is used as a prefix to the relevant OGC API endpoint used.
134-
135-
If a ``channel`` is not defined, only the relevant OGC API endpoint is used.
136-
137119
HTTP
138120
^^^^
139121

@@ -148,12 +130,16 @@ Example directive:
148130
channel: messages-a-data # optional
149131
hidden: true # default false
150132
133+
Additional information
134+
----------------------
135+
151136
.. note::
152137

153138
For any Pub/Sub endpoints requiring authentication, encode the ``url`` value as follows:
154139

155140
* ``mqtt://username:password@localhost:1883``
156141
* ``https://username:password@localhost``
142+
* ``tcp://username:password@localhost:9092``
157143

158144
As with any section of the pygeoapi configuration, environment variables may be used as needed, for example
159145
to set username/password information in a URL. If ``pubsub.broker.url`` contains authentication, and
@@ -166,5 +152,6 @@ Example directive:
166152

167153
If a ``channel`` is not defined, only the relevant OGC API endpoint is used.
168154

155+
169156
.. _`OGC API Publish-Subscribe Workflow - Part 1: Core`: https://docs.ogc.org/DRAFTS/25-030.html
170157
.. _`AsyncAPI`: https://www.asyncapi.com

0 commit comments

Comments
 (0)