view 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
line wrap: on
line source

==========================
gateway: Gateway management
==========================

``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.

list
====

List available gateways on a server. If no server JID is specified, the command will use the server of the current profile.

By default, only available gateways are shown. If you want to see unavailable gateways as well, you can use the ``-v, --verbose`` option.

example
-------

List available gateways on the server of the default profile::

  $ li gateway list

register
========

Register to a gateway using the specified gateway JID. This will usually show a
registration form that you'll have to complete.

example
-------

Register to the IRC gateway on a server::

  $ li gateway register ap.example.org

unregister
==========

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.

example
-------

Unregister from the SMS gateway on a server without confirmation::

  $ li gateway unregister -f irc.example.org