Mercurial > libervia-backend
diff doc/libervia-cli/profile.rst @ 3573:813595f88612
merge changes from main branch
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 17 Jun 2021 13:05:58 +0200 |
parents | 267e4987b58b |
children | ba4ef64a6938 |
line wrap: on
line diff
--- a/doc/libervia-cli/profile.rst Thu Jun 03 15:21:43 2021 +0200 +++ b/doc/libervia-cli/profile.rst Thu Jun 17 13:05:58 2021 +0200 @@ -1,8 +1,8 @@ -============================= -profile: SàT profile handling -============================= +================================== +profile: Libervia profile handling +================================== -Profiles are the names associated with accounts in SàT, for more informations you can +Profiles are the names associated with accounts in Libervia, for more informations you can check :ref:`glossary`. The `profile` commands help you create/delete/modify and manage profiles. @@ -12,7 +12,7 @@ Unsurprisingly this command connects your profile, i.e. log-in your XMPP account. This command uses :ref:`libervia-cli_common_profile` common commands, so you can use either ``-c, ---connect`` to connect to XMPP server, or ``--start-session`` if you want to start SàT +--connect`` to connect to XMPP server, or ``--start-session`` if you want to start Libervia profile session without connecting to XMPP server (for instance if you want to modify parameters without connecting to XMPP server). @@ -45,13 +45,13 @@ create ====== -Create a new SàT profile. The only mandatory argument is the profile name, but you'll +Create a new Libervia profile. The only mandatory argument is the profile name, but you'll probably want to associate an XMPP jid with ``-j JID, --jid JID`` and a profile password with ``-p PASSWORD, --password PASSWORD``. By default, profile password will be used for XMPP password (see note below), but you may specify XMPP password with ``-x PASSWORD, --xmpp-password PASSWORD``. -SàT is also capable to manage components, which can be seen as XMPP server independent +Libervia is also capable to manage components, which can be seen as XMPP server independent plugins. To create a component profile, you'll have to use ``-C COMPONENT, --component COMPONENT`` where ``COMPONENT`` is the component entry point (check the documentation of the component that you want to use to get its entry point). @@ -62,12 +62,12 @@ .. note:: profile password and XMPP password are not the same: the profile password is the - password of your SàT profile, while the XMPP password is the one checked by your XMPP + password of your Libervia profile, while the XMPP password is the one checked by your XMPP server. If specify a jid with ``--jid`` and you don't specify an XMPP password, the profile password will be used by default. The reason to have distinct password is that you may use a different password for - profile, including an empty one if you want SàT to connect your profile without + profile, including an empty one if you want Libervia to connect your profile without having to enter a password. Also the XMPP password is encrypted in database using the profile password (which is not stored in database, only a hash is kept). @@ -77,7 +77,7 @@ passwords in li are currently specified directly on the command-line and not prompted, this is not safe from a security point of view as people can see it on the screen, it may stay in your shell history, or visible on process list. Keep that in mind if you're - in a public environment or on a public machine. This will be improved for SàT 0.8. + in a public environment or on a public machine. This will be improved for Libervia 0.8. examples -------- @@ -91,10 +91,11 @@ ``file_sharing``). The jid of the service is specified with ``--jid`` (note that we don't use a node as it is a jid of a component) and the ``--xmpp-password`` is the shared secret. Here the profile password is kept empty to not have to enter manually the XMPP -password each time we connect the service:: +password each time we connect the service. We use the ``-A`` option to set +autoconnection:: $ li profile create file_sharing -j files.example.org -p "" --xmpp-password - some_shared_secret -C file_sharing + some_shared_secret -C file_sharing -A default @@ -115,7 +116,7 @@ delete ====== -Delete a profile and all its associated data. This delete the SàT profile and associated +Delete a profile and all its associated data. This delete the Libervia profile and associated data (i.e. local data), but doesn't request the XMPP server to delete anything. By default a confirmation is requested, use ``-f, --force`` to avoid it (be cautious with @@ -175,8 +176,8 @@ .. note:: Be cautious with ``--disable-password`` that means that no password will be needed with - any frontend of SàT to use this profile, and that XMPP password will be easy to - retrieve for anybody having an access to the machine where SàT is installed + any frontend of Libervia to use this profile, and that XMPP password will be easy to + retrieve for anybody having an access to the machine where Libervia is installed examples --------