annotate doc/libervia-cli/gateway.rst @ 4306:94e0968987cd

plugin XEP-0033: code modernisation, improve delivery, data validation: - Code has been rewritten using Pydantic models and `async` coroutines for data validation and cleaner element parsing/generation. - Delivery has been completely rewritten. It now works even if server doesn't support multicast, and send to local multicast service first. Delivering to local multicast service first is due to bad support of XEP-0033 in server (notably Prosody which has an incomplete implementation), and the current impossibility to detect if a sub-domain service handles fully multicast or only for local domains. This is a workaround to have a good balance between backward compatilibity and use of bandwith, and to make it work with the incoming email gateway implementation (the gateway will only deliver to entities of its own domain). - disco feature checking now uses `async` corountines. `host` implementation still use Deferred return values for compatibility with legacy code. rel 450
author Goffi <goffi@goffi.org>
date Thu, 26 Sep 2024 16:12:01 +0200
parents 9e7ea54b93ee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4302
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 ==========================
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 gateway: Gateway management
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 ==========================
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
4
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 ``gateway`` command allows you to list, register, and unregister from gateways (usually used to access other networks like ActivityPub or Email) on an XMPP server.
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 list
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 ====
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
9
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 List available gateways on a server. If no server JID is specified, the command will use the server of the current profile.
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 By default, only available gateways are shown. If you want to see unavailable gateways as well, you can use the ``-v, --verbose`` option.
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
13
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 example
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 -------
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 List available gateways on the server of the default profile::
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
18
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 $ li gateway list
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
20
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 register
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 ========
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
23
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 Register to a gateway using the specified gateway JID. This will usually show a
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 registration form that you'll have to complete.
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
26
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 example
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 -------
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 Register to the IRC gateway on a server::
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
31
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 $ li gateway register ap.example.org
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
33
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 unregister
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 ==========
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
36
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 Unregister from a gateway using the specified gateway JID. By default, a confirmation is requested before unregistering. You can skip the confirmation by using the ``-f, --force`` option.
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
38
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 example
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 -------
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
41
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 Unregister from the SMS gateway on a server without confirmation::
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
43
9e7ea54b93ee doc (cli): documentation for new `gateway` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 $ li gateway unregister -f irc.example.org