Fwd: [patch] A tiny patch clarifying port usage in doc/ports.md

1 view
Skip to first unread message

Vladimir Nikishkin

unread,
Aug 14, 2021, 9:03:15 AM8/14/21
to proso...@googlegroups.com
Dear Prosody developers,

The following patch is proposed, please consider it for inclusion:

# HG changeset patch
# User Vladimir Nikishkin <lock...@gmail.com>
# Date 1628944069 -28800
# Sat Aug 14 20:27:49 2021 +0800
# Node ID b34c05dcf12914481e442c3c3cbdc72f962a9888
# Parent 47b1717f88bfb4f2b815df632ce16df232359b64
Clarify port usage in doc/ports.md.

1. Add a note describing port usage.

diff -r 47b1717f88bf -r b34c05dcf129 doc/ports.md
--- a/doc/ports.md Tue Aug 03 14:02:14 2021 +0200
+++ b/doc/ports.md Sat Aug 14 20:27:49 2021 +0800
@@ -13,15 +13,24 @@

Here is an overview of default ports and the respective services:

- port service
- ------ ------------------------------------
- 5000 [File transfer proxy](/doc/modules/mod_proxy65)
- 5222 [Client connections](/doc/modules/mod_c2s)
- 5269 [Server-to-server connections](/doc/modules/mod_s2s)
- 5280 [HTTP](/doc/http)
- 5281 [HTTPS](/doc/http)
- 5347 [External components](/doc/components)
- 5582 [Telnet console](/doc/console)
+ port service
+ ---------- ------------------------------------
+ 5000/tcp [File transfer proxy](/doc/modules/mod_proxy65)
+ 5222/tcp [Client connections](/doc/modules/mod_c2s)
+ 5269/tcp [Server-to-server connections](/doc/modules/mod_s2s)
+ 5280/tcp [HTTP](/doc/http)
+ 5281/tcp [HTTPS](/doc/http)
+ 5347/tcp [External components](/doc/components)
+ 5582/tcp [Telnet console](/doc/console)
+
+As a rule of thumb, Prosody uses almost exclusively TCP for all its network
+communication. Rare exceptions (such as cooperating external
services, e.g. TURN)
+mention the protocol they use in their own documentation.
+
+Of the ports above, the https port uses standard TLS, the http port
is unencrypted,
+and "Client connections" and "Server-to-server connections" ports use
plain TCP by
+default, but can upgrade a connection using the STARTTLS option. "External
+components" and "Telnet console" only ever listen on a local interface.

# Default interfaces {#default_interfaces}


--
Yours sincerely, Vladimir Nikishkin
(Sent from GMail web interface.)
001_minor-doc-ports-md-port-clarification.patch

Kim Alvefur

unread,
Aug 14, 2021, 12:23:55 PM8/14/21
to Vladimir Nikishkin, proso...@googlegroups.com
Hi,

On Sat, Aug 14, 2021 at 08:44:05PM +0800, Vladimir Nikishkin wrote:
>Dear Prosody developers,
>
>The following patch is proposed, please consider it for inclusion:

Thanks, merged with some tweaks.

As per the page about Contributing https://prosody.im/doc/contributing
and if you look at the history, you should see that commit messages follow a
format like "doc/some/page: Some words". Following existing conventions
is nice.

--
Zash

signature.asc
Reply all
Reply to author
Forward
0 new messages