Mercurial > libervia-backend
view doc/jp/avatar.rst @ 3387:b3e7e3c49d8f
docker (compose): test environment variable + network alias:
`SAT_TEST_ENV_E2E` is set to `1` to indicate that e2e environment requirement are
available (notably specific accounts and hosts created). The e2e tests needing it won't be
launched if this variable is not set.
A network alias is set for the backend at `sat.test` (to have a tld available, needed for
some network libraries like OpenSSL).
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 12 Nov 2020 14:53:15 +0100 |
parents | 6cf4bd6972c2 |
children |
line wrap: on
line source
=============================== avatar: retrieve/upload avatars =============================== Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, SàT tries to hide the technical details so avatar are as easy as possible to manipulate for end-user. get === Retrieve the avatar of the given entity. Entity jid is specified as positional argument. If an avatar is found, a path to its cached file is printed. Please note that this is the cache used by all SàT ecosystem, **do not modify the cached image**. You may use it for read-only access, or copy it if you want to modify the image. You may use the ``-s, --show`` argument to display the found avatar. The software used to display the image can be specified in SàT configuration (cf. :ref:`configuration`), in the ``[jp]`` section: the ``image_cmd`` setting let you specify the path to the software. If ``image_cmd`` is not used, ``jp`` will try some common software, and if none is found, it will try to open the image in a browser (which may sometimes result in using the default image software of the platform). When available, cached avatar is returned by defaut. If you want to ignore the cache, use the ``--no-cache`` option (of course this can result in more network requests). example ------- Get the avatar of ``louise@example.org`` and display it:: $ jp avatar get --show louise@example.org set === Upload and set the given avatar for the profile. The only required argument is the path to the image to use as avatar. example ------- Set the avatar of the default profile:: $ jp avatar set ~/photos/some_photo.jpg