Mercurial > libervia-backend

comparison doc/libervia-cli/profile.rst @ 3573:813595f88612

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge changes from main branch
author Goffi <goffi@goffi.org>
date Thu, 17 Jun 2021 13:05:58 +0200
parents 267e4987b58b
children ba4ef64a6938
comparison
equal deleted inserted replaced
3541:888109774673 3573:813595f88612
1 ============================= 1 ==================================
2 profile: SàT profile handling 2 profile: Libervia profile handling
3 ============================= 3 ==================================
4 4
5 Profiles are the names associated with accounts in SàT, for more informations you can 5 Profiles are the names associated with accounts in Libervia, for more informations you can
6 check :ref:`glossary`. The `profile` commands help you create/delete/modify and manage 6 check :ref:`glossary`. The `profile` commands help you create/delete/modify and manage
7 profiles. 7 profiles.
8 8
9 9
10 connect 10 connect
11 ======= 11 =======
12 12
13 Unsurprisingly this command connects your profile, i.e. log-in your XMPP account. This 13 Unsurprisingly this command connects your profile, i.e. log-in your XMPP account. This
14 command uses :ref:`libervia-cli_common_profile` common commands, so you can use either ``-c, 14 command uses :ref:`libervia-cli_common_profile` common commands, so you can use either ``-c,
15 --connect`` to connect to XMPP server, or ``--start-session`` if you want to start SàT 15 --connect`` to connect to XMPP server, or ``--start-session`` if you want to start Libervia
16 profile session without connecting to XMPP server (for instance if you want to modify 16 profile session without connecting to XMPP server (for instance if you want to modify
17 parameters without connecting to XMPP server). 17 parameters without connecting to XMPP server).
18 18
19 Note that :ref:`libervia-cli_common_profile` common commands are available in commands needing a 19 Note that :ref:`libervia-cli_common_profile` common commands are available in commands needing a
20 connected profile, ``li profile connect`` is interesting if you only want to connect your 20 connected profile, ``li profile connect`` is interesting if you only want to connect your
43 43
44 44
45 create 45 create
46 ====== 46 ======
47 47
48 Create a new SàT profile. The only mandatory argument is the profile name, but you'll 48 Create a new Libervia profile. The only mandatory argument is the profile name, but you'll
49 probably want to associate an XMPP jid with ``-j JID, --jid JID`` and a profile password 49 probably want to associate an XMPP jid with ``-j JID, --jid JID`` and a profile password
50 with ``-p PASSWORD, --password PASSWORD``. By default, profile password will be used for 50 with ``-p PASSWORD, --password PASSWORD``. By default, profile password will be used for
51 XMPP password (see note below), but you may specify XMPP password with ``-x PASSWORD, 51 XMPP password (see note below), but you may specify XMPP password with ``-x PASSWORD,
52 --xmpp-password PASSWORD``. 52 --xmpp-password PASSWORD``.
53 53
54 SàT is also capable to manage components, which can be seen as XMPP server independent 54 Libervia is also capable to manage components, which can be seen as XMPP server independent
55 plugins. To create a component profile, you'll have to use ``-C COMPONENT, --component 55 plugins. To create a component profile, you'll have to use ``-C COMPONENT, --component
56 COMPONENT`` where ``COMPONENT`` is the component entry point (check the documentation of 56 COMPONENT`` where ``COMPONENT`` is the component entry point (check the documentation of
57 the component that you want to use to get its entry point). 57 the component that you want to use to get its entry point).
58 58
59 If you want a profile to connect automatically on backend startup (notably useful for 59 If you want a profile to connect automatically on backend startup (notably useful for
60 components), you can use the ``-A [{true,false}], --autoconnect [{true,false}]`` argument. 60 components), you can use the ``-A [{true,false}], --autoconnect [{true,false}]`` argument.
61 61
62 .. note:: 62 .. note::
63 63
64 profile password and XMPP password are not the same: the profile password is the 64 profile password and XMPP password are not the same: the profile password is the
65 password of your SàT profile, while the XMPP password is the one checked by your XMPP 65 password of your Libervia profile, while the XMPP password is the one checked by your XMPP
66 server. If specify a jid with ``--jid`` and you don't specify an XMPP password, the 66 server. If specify a jid with ``--jid`` and you don't specify an XMPP password, the
67 profile password will be used by default. 67 profile password will be used by default.
68 68
69 The reason to have distinct password is that you may use a different password for 69 The reason to have distinct password is that you may use a different password for
70 profile, including an empty one if you want SàT to connect your profile without 70 profile, including an empty one if you want Libervia to connect your profile without
71 having to enter a password. Also the XMPP password is encrypted in database using the 71 having to enter a password. Also the XMPP password is encrypted in database using the
72 profile password (which is not stored in database, only a hash is kept). 72 profile password (which is not stored in database, only a hash is kept).
73 73
74 74
75 .. note:: 75 .. note::
76 76
77 passwords in li are currently specified directly on the command-line and not prompted, 77 passwords in li are currently specified directly on the command-line and not prompted,
78 this is not safe from a security point of view as people can see it on the screen, it 78 this is not safe from a security point of view as people can see it on the screen, it
79 may stay in your shell history, or visible on process list. Keep that in mind if you're 79 may stay in your shell history, or visible on process list. Keep that in mind if you're
80 in a public environment or on a public machine. This will be improved for SàT 0.8. 80 in a public environment or on a public machine. This will be improved for Libervia 0.8.
81 81
82 examples 82 examples
83 -------- 83 --------
84 84
85 Nestor wants to create a profile for its account on ``example.org``, he specifies a 85 Nestor wants to create a profile for its account on ``example.org``, he specifies a
89 89
90 Create a component profile for the file sharing component (whose entry point is 90 Create a component profile for the file sharing component (whose entry point is
91 ``file_sharing``). The jid of the service is specified with ``--jid`` (note that we don't 91 ``file_sharing``). The jid of the service is specified with ``--jid`` (note that we don't
92 use a node as it is a jid of a component) and the ``--xmpp-password`` is the shared 92 use a node as it is a jid of a component) and the ``--xmpp-password`` is the shared
93 secret. Here the profile password is kept empty to not have to enter manually the XMPP 93 secret. Here the profile password is kept empty to not have to enter manually the XMPP
94 password each time we connect the service:: 94 password each time we connect the service. We use the ``-A`` option to set
95 autoconnection::
95 96
96 $ li profile create file_sharing -j files.example.org -p "" --xmpp-password 97 $ li profile create file_sharing -j files.example.org -p "" --xmpp-password
97 some_shared_secret -C file_sharing 98 some_shared_secret -C file_sharing -A
98 99
99 100
100 default 101 default
101 ======= 102 =======
102 103
113 114
114 115
115 delete 116 delete
116 ====== 117 ======
117 118
118 Delete a profile and all its associated data. This delete the SàT profile and associated 119 Delete a profile and all its associated data. This delete the Libervia profile and associated
119 data (i.e. local data), but doesn't request the XMPP server to delete anything. 120 data (i.e. local data), but doesn't request the XMPP server to delete anything.
120 121
121 By default a confirmation is requested, use ``-f, --force`` to avoid it (be cautious with 122 By default a confirmation is requested, use ``-f, --force`` to avoid it (be cautious with
122 this option). 123 this option).
123 124
173 flag for that. 174 flag for that.
174 175
175 .. note:: 176 .. note::
176 177
177 Be cautious with ``--disable-password`` that means that no password will be needed with 178 Be cautious with ``--disable-password`` that means that no password will be needed with
178 any frontend of SàT to use this profile, and that XMPP password will be easy to 179 any frontend of Libervia to use this profile, and that XMPP password will be easy to
179 retrieve for anybody having an access to the machine where SàT is installed 180 retrieve for anybody having an access to the machine where Libervia is installed
180 181
181 examples 182 examples
182 -------- 183 --------
183 184
184 Pierre has changed server, he can update his jid and password like this:: 185 Pierre has changed server, he can update his jid and password like this::