Mercurial > libervia-backend

comparison doc/jp/account.rst @ 3041:72583524cfd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (jp): jp commands are now fully documented: rel 232
author Goffi <goffi@goffi.org>
date Tue, 01 Oct 2019 22:49:06 +0200
parents
children
comparison
equal deleted inserted replaced
3040:fee60f17ebac 3041:72583524cfd3
1 ================================
2 account: XMPP account management
3 ================================
4
5 ``account`` command help you to create or manage the XMPP account of a server, using
6 In-Band Registration (`XEP-0077`_).
7
8 .. _XEP-0077: https://xmpp.org/extensions/xep-0077.html
9
10 create
11 ======
12
13 Create a XMPP account. You have to specify your jid and password as positional arguments.
14 By default the registration is done on ``localhost`` with default XMPP Client 2 Server
15 port (i.e. 5222), but you can specify other host/port using ``-H HOST, --host HOST`` and
16 ``-P PORT, --port PORT``. You may also specify an e-mail address using ``-e EMAIL, --email
17 EMAIL`` (use of this data depend of the server implementation).
18
19 By default, no SàT profile is created and associated to this new XMPP account, but you can
20 use ``-p PROFILE, --profile PROFILE`` if you are willing to have one.
21
22 example
23 -------
24
25 Create account for the new user Nestor at ``nestor@example.org`` and associate it with the
26 SàT profile ``nestor``::
27
28 $ jp account create nestor@example.org some_password -p nestor
29
30
31 modify
32 ======
33
34 Modify an existing XMPP account password. This will modify the XMPP account linked to the
35 given profile.
36
37 .. note::
38
39 Only the XMPP password on the server is changed, not the one registered in the
40 parameter of SàT. You may have to update the parameter of your profile if the new
41 password doesn't correspond to your parameters one (you can do that with jp param set
42 or with most SàT frontends in parameters).
43
44 example
45 -------
46
47 Change the XMPP password of the XMPP account of the default profile::
48
49 $ jp account modify new_password
50
51
52 delete
53 ======
54
55 Delete the XMPP account linked to the given profile from the XMPP server. Before using
56 this command, please be sure to understand well that **THIS WILL REMOVE THE WHOLE XMPP
57 ACCOUNT AND DATA FROM THE XMPP SERVER**.
58
59 By default a confirmation is requested, you can do this without confirmation by using
60 ``-f, --force``, however this is **NOT RECOMMENDED**, be sure to understand what you're
61 doing if you use this option (and be sure to spell correctly the profile, if you forget
62 the ``-p PROFILE, --profile`` argument for instance, this would delete entirely the
63 default profile).
64
65 .. note::
66
67 Be extra careful with this command, as it will remove the whole account from the
68 server, and the associated data.
69
70 example
71 -------
72
73 Delete the XMPP account of Pierre, which is not on the local server anymore::
74
75 $ jp account delete -p pierre