doc: fix remaining SàT references/typos + add libervia-cli missing commands
This commit is contained in:
Goffi
parent
7365f67601
commit
6c2d81696c
26 changed files with 299 additions and 156 deletions
|
|
@ -6,14 +6,14 @@ Configuration
|
|||
|
||||
Libervia main configuration is set in a file named ``libervia.conf`` (which may be prefixed
|
||||
by a ``.`` if you want to hide it on suitable platforms). It is a common file used both by
|
||||
backend and all frontends (and even related project like SàT Pubsub).
|
||||
backend and all frontends (and even related project like Libervia Pubsub).
|
||||
|
||||
This file can be located in the following paths (in order of parsing):
|
||||
- ``/etc``
|
||||
- ``~`` (``$HOME`` or your home directory)
|
||||
- XDG directory for configuration (most of time it is
|
||||
``~/.config/libervia/``)
|
||||
- the parent directory of SàT installation path
|
||||
- the parent directory of Libervia installation path
|
||||
|
||||
If several configurations files are found, they are merged. In case of conflict, the
|
||||
option parsed last is the one used (in other words: if you have an option set in
|
||||
|
|
@ -31,7 +31,7 @@ your media.
|
|||
|
||||
Each frontend can have specific section with its name in lowercase (sections are case
|
||||
sensitive), and some backend plugin can use specific sections too (usually named ``plugin
|
||||
<plugin name>``). The ``pubsub`` section is used by ``SàT PubSub``. A section can also
|
||||
<plugin name>``). The ``pubsub`` section is used by ``Libervia PubSub``. A section can also
|
||||
have the name of a web site used with Libervia web framework.
|
||||
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ frontend name (in lower case)
|
|||
- ``[plugin muc]``
|
||||
- ``[plugin search]``
|
||||
``[pubsub]``
|
||||
SàT PubSub settings
|
||||
Libervia PubSub settings
|
||||
``[<website name>]``
|
||||
the settings of a website for Libervia web framework
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ the comments to get the meaning of each option.
|
|||
.. sourcecode:: cfg
|
||||
|
||||
[DEFAULT]
|
||||
; where SàT media are located
|
||||
; where Libervia media are located
|
||||
media_dir = ~/workspace/sat_media
|
||||
log_level = debug
|
||||
; domain used for new accounts
|
||||
|
|
|
|||
|
|
@ -45,8 +45,8 @@ instance your home directory::
|
|||
And enter the following commands (here we install Libervia with SVG support, which is needed to
|
||||
display SVG avatars on some frontends)::
|
||||
|
||||
$ python3 -m venv sat
|
||||
$ source sat/bin/activate
|
||||
$ python3 -m venv libervia
|
||||
$ source libervia/bin/activate
|
||||
$ pip install -U pip wheel
|
||||
$ pip install -r requirements.txt
|
||||
|
||||
|
|
@ -59,11 +59,11 @@ After installing Libervia, you need to install the media::
|
|||
$ cd
|
||||
$ hg clone https://repos.goffi.org/sat_media
|
||||
|
||||
then, create the directory ``~/.config/sat``::
|
||||
then, create the directory ``~/.config/libervia``::
|
||||
|
||||
$ mkdir -p ~/.config/sat
|
||||
$ mkdir -p ~/.config/libervia
|
||||
|
||||
and the file ``~/.config/sat/libervia.conf`` containing:
|
||||
and the file ``~/.config/libervia/libervia.conf`` containing:
|
||||
|
||||
.. sourcecode:: cfg
|
||||
|
||||
|
|
@ -77,21 +77,21 @@ You can check :ref:`configuration` for details
|
|||
Usage
|
||||
=====
|
||||
|
||||
To launch the sat backend, enter::
|
||||
To launch the Libervia backend, enter::
|
||||
|
||||
$ sat
|
||||
$ libervia-backend
|
||||
|
||||
…or, if you want to launch it in foreground::
|
||||
|
||||
$ sat fg
|
||||
$ libervia-backend fg
|
||||
|
||||
You can stop it with::
|
||||
|
||||
$ sat stop
|
||||
$ libervia-backend stop
|
||||
|
||||
To know if backend is launched or not::
|
||||
|
||||
$ sat status
|
||||
$ libervia-backend status
|
||||
|
||||
**NOTE**: if ``misc/org.libervia.Libervia.service`` is installed correctly (which should
|
||||
be done by during the installation), the backend is automatically launched when a frontend
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ port (i.e. 5222), but you can specify other host/port using ``-H HOST, --host HO
|
|||
``-P PORT, --port PORT``. You may also specify an e-mail address using ``-e EMAIL, --email
|
||||
EMAIL`` (use of this data depend of the server implementation).
|
||||
|
||||
By default, no SàT profile is created and associated to this new XMPP account, but you can
|
||||
By default, no Libervia profile is created and associated to this new XMPP account, but you can
|
||||
use ``-p PROFILE, --profile PROFILE`` if you are willing to have one.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Create account for the new user Nestor at ``nestor@example.org`` and associate it with the
|
||||
SàT profile ``nestor``::
|
||||
Libervia profile ``nestor``::
|
||||
|
||||
$ li account create nestor@example.org some_password -p nestor
|
||||
|
||||
|
|
@ -37,9 +37,9 @@ given profile.
|
|||
.. note::
|
||||
|
||||
Only the XMPP password on the server is changed, not the one registered in the
|
||||
parameter of SàT. You may have to update the parameter of your profile if the new
|
||||
parameter of Libervia. You may have to update the parameter of your profile if the new
|
||||
password doesn't correspond to your parameters one (you can do that with li param set
|
||||
or with most SàT frontends in parameters).
|
||||
or with most Libervia frontends in parameters).
|
||||
|
||||
example
|
||||
-------
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ is sent), you may use the ``-l, --loop`` option. Most of time you'll want to use
|
|||
|
||||
.. note::
|
||||
|
||||
SàT already creates automatically a remote control if it finds a media player. This
|
||||
Libervia already creates automatically a remote control if it finds a media player. This
|
||||
manual way to create a remote control predate the automatic remote control, and is
|
||||
currently more flexible in that you can specify who can access the remote control
|
||||
(automatic remote control is only accessible by the jid of the profile).
|
||||
|
|
|
|||
68
doc/libervia-cli/appication.rst
Normal file
68
doc/libervia-cli/appication.rst
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
=============================================
|
||||
application: external applications management
|
||||
=============================================
|
||||
|
||||
Libervia can launch and manage external applications. This is useful to integrate external
|
||||
services, notably in the web frontend. The command can be used either with ``application``
|
||||
or the shortcut ``app``.
|
||||
|
||||
list
|
||||
====
|
||||
|
||||
List available applications. This command can show either the list of available
|
||||
application (which could be launched) and/or the list of running application.
|
||||
|
||||
By default both available and running application are shown, this can be filtered by using
|
||||
``-f {available,running}, --filter {available,running}``
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
List available applications::
|
||||
|
||||
$ li app list -f available
|
||||
|
||||
start
|
||||
=====
|
||||
|
||||
Start an application. Depending on the application and its availability locally, this make
|
||||
take some time (resources may have to be downloaded).
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Start Weblate::
|
||||
|
||||
$ li app start weblate
|
||||
|
||||
.. _li_app_stop:
|
||||
|
||||
stop
|
||||
=====
|
||||
|
||||
Stop an application. If several instances of the same application are running, ``-i ID,
|
||||
--id ID`` can be used to specify which one must be stopped.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Stop Weblate::
|
||||
|
||||
$ li app stop weblate
|
||||
|
||||
|
||||
exposed
|
||||
=======
|
||||
|
||||
List exposed values from a running application. Exposed values may be the port used,
|
||||
passwords automatically generated, or fields useful for web integration.
|
||||
|
||||
As for :ref:`li_app_stop`, if several instances of the same application are running, one
|
||||
can be specified using ``-i ID, --id ID``.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Show exposed values of a running Weblate::
|
||||
|
||||
$ li account application exposed weblate
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
avatar: retrieve/upload avatars
|
||||
===============================
|
||||
|
||||
Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, SàT
|
||||
Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, Libervia
|
||||
tries to hide the technical details so avatar are as easy as possible to manipulate for
|
||||
end-user.
|
||||
|
||||
|
|
@ -12,11 +12,11 @@ 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
|
||||
cache used by all Libervia 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
|
||||
display the image can be specified in Libervia configuration (cf. :ref:`configuration`), in the
|
||||
``[li]`` section: the ``image_cmd`` setting let you specify the path to the software. If
|
||||
``image_cmd`` is not used, ``li`` 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
|
||||
|
|
|
|||
|
|
@ -243,6 +243,20 @@ instead of the default ``.md``, you can use this:
|
|||
the first ``markdown`` is the name of the syntax (could be an other syntax like ``xhtml``),
|
||||
while the second if the file extension.
|
||||
|
||||
rename
|
||||
======
|
||||
|
||||
Move a item to a new ID. This works the same as :ref:`li-pubsub_rename`, the only
|
||||
difference is that node defaults to microblog default namespace.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
After a typo, a use want to rename the blog item with ID ``my_great_tittle_123a`` to
|
||||
``my_great_title_123a``::
|
||||
|
||||
$ li blog rename -i my_great_tittle_123a my_great_title_123a
|
||||
|
||||
preview
|
||||
=======
|
||||
|
||||
|
|
@ -250,12 +264,12 @@ This command will show the specified file in browser, and refresh it when change
|
|||
detected. Configuration is the same as for `edit preview <edit_preview_>`_. This can be
|
||||
used if you have already started an edition with ``li blog edit`` but forgot to use the ``-P, --preview`` arguments.
|
||||
|
||||
example:
|
||||
--------
|
||||
example
|
||||
-------
|
||||
|
||||
Preview the draft at ``~/local/sat/blog/some_name/blog_something.md``::
|
||||
Preview the draft at ``~/.local/share/libervia/blog/some_name/blog_something.md``::
|
||||
|
||||
$ li blog preview ~/local/sat/blog/some_name/blog_something.md
|
||||
$ li blog preview ~/.local/share/libervia/blog/some_name/blog_something.md
|
||||
|
||||
.. _libervia-cli_blog_import:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,13 +3,13 @@ bookmarks: get/set bookmarks
|
|||
============================
|
||||
|
||||
Bookmarks are links to MUC rooms or URLs with a few metadata. Due to historical reasons,
|
||||
XMPP has several ways to handle bookmarks, and SàT handle them as transparently as
|
||||
XMPP has several ways to handle bookmarks, and Libervia handle them as transparently as
|
||||
possible.
|
||||
|
||||
With SàT there are 3 places where you can get/store your bookmarks:
|
||||
With Libervia there are 3 places where you can get/store your bookmarks:
|
||||
|
||||
local
|
||||
the bookmarks is stored only locally in the database of SàT. It won't be available to
|
||||
the bookmarks is stored only locally in the database of Libervia. It won't be available to
|
||||
other devices.
|
||||
private
|
||||
the bookmarks use the old private XML storage (`XEP-0049`_). It is not recommended to
|
||||
|
|
@ -18,7 +18,7 @@ pubsub
|
|||
the bookmarks use PEP storage (`XEP-0223`_), this is the currently recommended way to
|
||||
store bookmarks.
|
||||
|
||||
When possible, you can specify ``auto`` to let SàT choose the best location (i.e.
|
||||
When possible, you can specify ``auto`` to let Libervia choose the best location (i.e.
|
||||
``pubsub`` if available, then ``private`` then ``local`` if nothing else is possible).
|
||||
|
||||
.. _XEP-0049: https://xmpp.org/extensions/xep-0049.html
|
||||
|
|
@ -95,4 +95,4 @@ Add a bookmark to Libervia official chat room::
|
|||
|
||||
Add a link to Libervia official website::
|
||||
|
||||
$ li bookmarks add -t url https://www.salut-a-toi.org -n "SàT officiel"
|
||||
$ li bookmarks add -t url https://www.salut-a-toi.org -n "Libervia officiel"
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
debug: tools to help debugging/monitoring Libervia
|
||||
=====================================================
|
||||
|
||||
``debug`` groups commands to monitor or manipulate SàT and XMPP stream.
|
||||
``debug`` groups commands to monitor or manipulate Libervia and XMPP stream.
|
||||
|
||||
.. _libervia-cli_debug_bridge_method:
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ s hell string, and inside it we use double quote (``"``) for Python strings::
|
|||
|
||||
This is for debugging only, if you want to send message with li, use :ref:`libervia-cli_message_send`.
|
||||
|
||||
Get version string of SàT::
|
||||
Get version string of Libervia::
|
||||
|
||||
$ li debug bridge method getVersion
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ encryption: encryption sessions handling
|
|||
========================================
|
||||
|
||||
Libervia being an XMPP client does encryption by default between client and server. In
|
||||
addition, SàT is also capable of doing end-to-end (e2e) encryption, meaning that the
|
||||
addition, Libervia is also capable of doing end-to-end (e2e) encryption, meaning that the
|
||||
payload of messages are encrypted to be hidden from the servers (and their
|
||||
administrators). The ``encryption`` commands are here to handle those e2e encryption
|
||||
sessions and algorithms.
|
||||
|
|
@ -56,7 +56,7 @@ Start e2e session with an entity.
|
|||
You need to specify the JID of the entity you want to start a session with as a positional
|
||||
argument.
|
||||
|
||||
By default, SàT will select itself the algorithm to use among those available, but you can
|
||||
By default, Libervia will select itself the algorithm to use among those available, but you can
|
||||
specify one using either its name with ``-n NAME, --name NAME`` or its namespace using
|
||||
``-N NAMESPACE, --namespace``. ``NAME`` is the short name of the algorithm, e.g. ``omemo``
|
||||
while the namespace is the longer (e.g. ``urn:xmpp:otr:0``).
|
||||
|
|
@ -72,7 +72,7 @@ command will succeed in all cases and nothing will be changed.
|
|||
examples
|
||||
--------
|
||||
|
||||
Start e2e encryption with Pierre, using the algorithm selected by SàT::
|
||||
Start e2e encryption with Pierre, using the algorithm selected by Libervia::
|
||||
|
||||
$ li encryption start louise@example.net
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ Terminate an e2e session with given entity. The entity must be specified as posi
|
|||
argument.
|
||||
|
||||
After this command is run, the messages with specified entity will not be e2e encrypted
|
||||
anymore (but this won't affect encryption between SàT and XMPP server and between XMPP
|
||||
anymore (but this won't affect encryption between Libervia and XMPP server and between XMPP
|
||||
servers).
|
||||
|
||||
example
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ By default the name of the source file is used, but you use ``-n NAME, --name NA
|
|||
specify another one.
|
||||
|
||||
The path and namespace (set with ``-d PATH, --path PATH`` and ``-N NAMESPACE, --namespace
|
||||
NAMESPACE``) are non-standard metadata used by SàT to organise files (``PATH`` being like
|
||||
NAMESPACE``) are non-standard metadata used by Libervia to organise files (``PATH`` being like
|
||||
a file path on locale file system, and ``NAMESPACE`` being a name to associate to a group
|
||||
of files, for instance for a photo album).
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ Ask to get a file from a device/sharing service. A file is requested using one o
|
|||
metadata, which can be the file name (with ``-n NAME, --name NAME``), its hash (with ``-H
|
||||
HASH, --hash HASH`` and the algorithm may be specified with ``-a HASH_ALGO, --hash-algo
|
||||
HASH_ALGO``), its path (with ``-d PATH, --path PATH``) and its namespace (with ``-N
|
||||
NAMESPACE, --namespace NAMESPACE``). Note that ``PATH`` and ``NAMESPACE`` are SàT specific
|
||||
NAMESPACE, --namespace NAMESPACE``). Note that ``PATH`` and ``NAMESPACE`` are Libervia specific
|
||||
and not (yet?) XMPP standards.
|
||||
|
||||
If you already know the hash, it's the most efficient and recommended way to retrieve a
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ file/share/affiliations: file sharing affiliations management
|
|||
``affiliations`` let you manage access permission to your shared files repository, in a
|
||||
way similar as for pubsub.
|
||||
|
||||
Affiliations with file sharing are not standard and will only work with the SàT file
|
||||
Affiliations with file sharing are not standard and will only work with the Libervia file
|
||||
sharing component.
|
||||
|
||||
Affiliations are similar to pubsub ones:
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ file/share/configuration: file sharing node configuration
|
|||
=========================================================
|
||||
|
||||
``configuration`` commands are use to check or modify settings of a file sharing node.
|
||||
This is not standard and specific to SàT file sharing component.
|
||||
This is not standard and specific to Libervia file sharing component.
|
||||
|
||||
The configuration is similar as pubsub one.
|
||||
|
||||
|
|
|
|||
111
doc/libervia-cli/list.rst
Normal file
111
doc/libervia-cli/list.rst
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
=================================
|
||||
list: create and manage lists
|
||||
=================================
|
||||
|
||||
list is a generic tools to create items with metadata and states (where state can be
|
||||
``queued``, ``done``, etc). This can be used for many things, from TODO list to bugs
|
||||
management.
|
||||
|
||||
get
|
||||
===
|
||||
|
||||
Retrieve one or more lists and display them. A project may use magic string in README to
|
||||
indicate PubSub service and node to use, in which case use just need to be in the
|
||||
directory of the project.
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Retrieve last 5 lists (ordered by creation) from a project using magic string in README::
|
||||
|
||||
$ li list get -m 5 -o creation
|
||||
|
||||
Retrieve the list with id ``123`` on service ``pubsub.example.org``::
|
||||
|
||||
$ li list get -s pubsub.example.org -i 123
|
||||
|
||||
|
||||
set
|
||||
===
|
||||
|
||||
Create/replace or update a list item. You can specify fields using the ``-f NAME [VALUES
|
||||
...], --field NAME [VALUES ...]``, several values can be set. For ``text-multi`` (multiple
|
||||
lines of text), each line is set in distinct value.
|
||||
|
||||
The ``-U {auto,true,false}, --update {auto,true,false}`` indicates if the item must be
|
||||
updated (non specified values are kept) or fully replaced (non specified values would then
|
||||
be default, even if they were previously set in the item). If ``auto`` is used (this is
|
||||
the default), ``--update=true`` is used when ``item_id`` is specified, otherwise a new
|
||||
item is created.
|
||||
|
||||
If ``-n NODE, --node NODE`` is not specified, it uses tickets default namespace.
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Modify priority of a ticket with id ``123`` to ``major`` (the ticket is updated and not
|
||||
replaced due to the default ``--update auto``)::
|
||||
|
||||
$ li list set -s pubsub.example.org -i 123 -f priority major
|
||||
|
||||
Set ``body`` for a new item when its schemas makes it a ``text-multi``::
|
||||
|
||||
$ li list set -s pubsub.example.org -f body "line 1" "line 2" "line 3"
|
||||
|
||||
delete
|
||||
======
|
||||
|
||||
Delete an item from a list. The options are the same as for :ref:`li_pubsub_delete`, the
|
||||
only different is that ``-n NODE, --node NODE`` defaults to tickets namespace.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Delete item with id ``456`` from tickets on PubSub service ``pubsub.example.org``::
|
||||
|
||||
$ li pubsub delete -s pubsub.example.org -i 456
|
||||
|
||||
import
|
||||
======
|
||||
|
||||
Import lists from an external source. This works in the same way as
|
||||
:ref:`libervia-cli_blog_import`: you need to specify an importer and a data location. If you let
|
||||
both positional argument empty, you'll get list of importers, if you specify importer but
|
||||
not data location, you'll get a description on how the importer works.
|
||||
|
||||
If you want to see a progress bar for the import, use the ``-P, --progress`` option, this
|
||||
is recommended for most imports.
|
||||
|
||||
Some importers may have specific option (check description for details), you can specify
|
||||
them with ``o NAME VALUE, --option NAME VALUE``
|
||||
|
||||
When you import a list, the list will be created according to the schema of the PubSub
|
||||
node. By default, the metadata of the original list will be put to the one of the same
|
||||
name in the dest PubSub item. But of course the schema of your destination PubSub node may
|
||||
differ from the original metadata. In this case, you can use ``-m IMPORTED_FIELD
|
||||
DEST_FIELD, --map IMPORTED_FIELD DEST_FIELD`` to specify how the mapping mus be done
|
||||
(``IMPORTED_FIELD is the name of the field in the original list, while ``DEST_FIELD`` if
|
||||
the name of the field in your node schema).
|
||||
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Get list of list importers::
|
||||
|
||||
$ li list import
|
||||
|
||||
Get description of list importer for Bugzilla::
|
||||
|
||||
$ li list import bugzilla
|
||||
|
||||
Import lists from a Bugzilla XML export file at ``~/bugzilla_export.xml`` to the
|
||||
``pubsub.example.org`` PubSub service. We use default lists node and want a progression
|
||||
bar::
|
||||
|
||||
$ li list import -P -s pubsub.example.org ~/bugzilla_export.xml
|
||||
|
||||
Same import, but this time we want to map the field ``assigned_to_name`` from Bugzilla to
|
||||
the field ``assigned_to`` in our schema::
|
||||
|
||||
$ li list import -P -s pubsub.example.org -m assigned_to_name assigned_to ~/bugzilla_export.xml
|
||||
|
|
@ -50,10 +50,10 @@ Retrieve messages from last 2 days::
|
|||
|
||||
$ li message mam -S "2 days ago"
|
||||
|
||||
Retrieve messages from last 5 hours on SàT official chat room::
|
||||
Retrieve messages from last 5 hours on Libervia official chat room::
|
||||
|
||||
$ li message mam -S "5 hours ago" -s sat@chat.jabberfr.org
|
||||
|
||||
Retrieve 2 first messages of 2019 on SàT official chat room::
|
||||
Retrieve 2 first messages of 2019 on Libervia official chat room::
|
||||
|
||||
$ li message mam -S 2019-01-01 -s sat@chat.jabberfr.org -m 2
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
============================
|
||||
param: manage SàT parameters
|
||||
============================
|
||||
=================================
|
||||
param: manage Libervia parameters
|
||||
=================================
|
||||
|
||||
``param`` commands allows to retrieve or set parameters as well as to export/import them
|
||||
to a XML file.
|
||||
|
|
@ -63,7 +63,7 @@ Get the constraint of the ``Priority`` parameters in ``Connection`` category::
|
|||
set
|
||||
===
|
||||
|
||||
As expected, this command set a SàT parameter. The ``category``, ``name`` and ``value``
|
||||
As expected, this command set a Libervia parameter. The ``category``, ``name`` and ``value``
|
||||
are needed as positional arguments.
|
||||
|
||||
``--security-limit SECURITY_LIMIT`` can be used if you want an update to be rejected if
|
||||
|
|
|
|||
|
|
@ -36,8 +36,8 @@ example
|
|||
|
||||
Send a video to louise::
|
||||
|
||||
$ li pipe out louise@example.org/sat < some_video.webm
|
||||
$ li pipe out louise@example.org/libervia.123 < some_video.webm
|
||||
|
||||
Send output from ``cal`` command to louise::
|
||||
|
||||
$ cal | li pipe out louise@example.org/sat
|
||||
$ cal | li pipe out louise@example.org/libervia.123
|
||||
|
|
|
|||
|
|
@ -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 @@ connect
|
|||
|
||||
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 @@ Disconnect the profile ``pierre``::
|
|||
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 @@ components), you can use the ``-A [{true,false}], --autoconnect [{true,false}]``
|
|||
.. 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 @@ components), you can use the ``-A [{true,false}], --autoconnect [{true,false}]``
|
|||
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
|
||||
--------
|
||||
|
|
@ -116,7 +116,7 @@ Print default profile::
|
|||
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
|
||||
|
|
@ -176,8 +176,8 @@ flag for that.
|
|||
.. 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
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -45,6 +45,8 @@ Retrieve the last 5 notes from our custom notes node::
|
|||
|
||||
$ li pubsub get -n notes -m 5
|
||||
|
||||
.. _li_pubsub_delete:
|
||||
|
||||
delete
|
||||
======
|
||||
|
||||
|
|
@ -77,6 +79,25 @@ Edit the last note in our custom node::
|
|||
|
||||
$ li pubsub edit -n notes -L
|
||||
|
||||
.. _li-pubsub_rename:
|
||||
|
||||
rename
|
||||
======
|
||||
|
||||
Move a item to a new ID. As there is currently no "rename" or "move" operation in XMPP
|
||||
PubSub, this is done by republishing the item with the new ID, then deleting the old item
|
||||
if the publication succeed.
|
||||
|
||||
This is notably useful when user friendly URL based on ID are used, and one need to fix a
|
||||
typo or something else.
|
||||
|
||||
example
|
||||
-------
|
||||
|
||||
Rename a PubSub item with ID ``123`` to ``456``::
|
||||
|
||||
$ li pubsub rename -n some_node -i 123 456
|
||||
|
||||
subscribe
|
||||
=========
|
||||
|
||||
|
|
@ -292,7 +313,7 @@ do the transformation, you have to use ``--apply`` argument.
|
|||
|
||||
If you have to modify the ``publisher`` of an item, you need specific privileges. The
|
||||
``--admin`` allows you do to that, but it must be supported by your PubSub service
|
||||
(currently only ``SàT PubSub`` supports this non standard feature).
|
||||
(currently only ``Libervia PubSub`` supports this non standard feature).
|
||||
|
||||
To modify all items of a node, use the ``-A, --all`` option. This will use `RSM`_
|
||||
repetitively until all items are treated. Of course that means that your PubSub service
|
||||
|
|
|
|||
|
|
@ -19,13 +19,13 @@ are user actions launched on specific events.
|
|||
|
||||
``python_code``
|
||||
Python code which will be directly executed. 3 variables will be set: ``host`` which
|
||||
contain the main SàT instance, ``client`` which contain the session attached to the
|
||||
contain the main Libervia instance, ``client`` which contain the session attached to the
|
||||
profile, and ``item`` which contain the item attached to the event.
|
||||
|
||||
.. note::
|
||||
|
||||
Hooks are executed in SàT context, and must be asynchronous. If they block, the whole
|
||||
SàT execution will be blocked. They have access to everything, so don't run a code that
|
||||
Hooks are executed in Libervia context, and must be asynchronous. If they block, the whole
|
||||
Libervia execution will be blocked. They have access to everything, so don't run a code that
|
||||
you don't absolutely trust.
|
||||
|
||||
.. note::
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ pubsub/node/schema: nodes schema handling
|
|||
=========================================
|
||||
|
||||
``node schema`` is an experimental feature to associate a data form with a PubSub node, and
|
||||
reject items not following this form. This feature is currently only available with SàT
|
||||
reject items not following this form. This feature is currently only available with Libervia
|
||||
PubSub.
|
||||
|
||||
Those commands can only be used by an owner of the node.
|
||||
|
|
|
|||
|
|
@ -107,9 +107,9 @@ purge
|
|||
This command is used to remove from the roster all contacts which have no subscription or
|
||||
only partial subscription.
|
||||
|
||||
By default, only contacts without subscription at all are removed. With ``--no_from`` you
|
||||
By default, only contacts without subscription at all are removed. With ``--no-from`` you
|
||||
also remove contacts which have no subscription to you (but you have a subscription to
|
||||
them), and with ``--no_to`` you also remove contacts that you are not subscribed to (but
|
||||
them), and with ``--no-to`` you also remove contacts that you are not subscribed to (but
|
||||
who are subscribed to you).
|
||||
|
||||
example
|
||||
|
|
@ -118,12 +118,12 @@ example
|
|||
Remove all contacts from default profile which have no subscription at all or from which
|
||||
the default profile is not subscribed to::
|
||||
|
||||
$ li roster purge --no_to
|
||||
$ li roster purge --no-to
|
||||
|
||||
resync
|
||||
======
|
||||
|
||||
SàT uses `roster versioning`_ to optimize the synchronisation of roster with server on
|
||||
Libervia uses `roster versioning`_ to optimize the synchronisation of roster with server on
|
||||
client connection. This means that once the roster has been retrieved, on each following
|
||||
connection, only the difference of contacts (i.e. which new or removed contacts) is
|
||||
received.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
========================
|
||||
shell: use SàT with REPL
|
||||
========================
|
||||
=============================
|
||||
shell: use Libervia with REPL
|
||||
=============================
|
||||
|
||||
``shell`` launch a read–eval–print loop (REPL) with some helpers to launch li commands.
|
||||
This is useful if you are willing to a session when you'll use several commands in a row
|
||||
|
|
|
|||
|
|
@ -1,72 +0,0 @@
|
|||
=================================
|
||||
ticket: create and manage tickets
|
||||
=================================
|
||||
|
||||
Ticket is a generic tools to create items with metadata and states (where state can be
|
||||
``queued``, ``done``, etc). This can be used for many things, from TODO list to bugs
|
||||
management.
|
||||
|
||||
get
|
||||
===
|
||||
|
||||
Retrieve one or more tickets and display them. A project may use magic string in README to
|
||||
indicate PubSub service and node to use, in which case use just need to be in the
|
||||
directory of the project.
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Retrieve last 5 tickets (ordered by creation) from a project using magic string in README::
|
||||
|
||||
$ li ticket get -m 5 -o creation
|
||||
|
||||
Retrieve the ticket with id ``123`` on service ``pubsub.example.org``::
|
||||
|
||||
$ li ticket get -s pubsub.example.org -i 123
|
||||
|
||||
|
||||
|
||||
import
|
||||
======
|
||||
|
||||
Import tickets from an external source. This works in the same way as
|
||||
:ref:`libervia-cli_blog_import`: you need to specify an importer and a data location. If you let
|
||||
both positional argument empty, you'll get list of importers, if you specify importer but
|
||||
not data location, you'll get a description on how the importer works.
|
||||
|
||||
If you want to see a progress bar for the import, use the ``-P, --progress`` option, this
|
||||
is recommended for most imports.
|
||||
|
||||
Some importers may have specific option (check description for details), you can specify
|
||||
them with ``o NAME VALUE, --option NAME VALUE``
|
||||
|
||||
When you import a ticket, the ticket will be created according to the schema of the PubSub
|
||||
node. By default, the metadata of the original ticket will be put to the one of the same
|
||||
name in the dest PubSub item. But of course the schema of your destination PubSub node may
|
||||
differ from the original metadata. In this case, you can use ``-m IMPORTED_FIELD
|
||||
DEST_FIELD, --map IMPORTED_FIELD DEST_FIELD`` to specify how the mapping mus be done
|
||||
(``IMPORTED_FIELD is the name of the field in the original ticket, while ``DEST_FIELD`` if
|
||||
the name of the field in your node schema).
|
||||
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Get list of ticket importers::
|
||||
|
||||
$ li ticket import
|
||||
|
||||
Get description of ticket importer for Bugzilla::
|
||||
|
||||
$ li ticket import bugzilla
|
||||
|
||||
Import tickets from a Bugzilla XML export file at ``~/bugzilla_export.xml`` to the
|
||||
``pubsub.example.org`` PubSub service. We use default tickets node and want a progression
|
||||
bar::
|
||||
|
||||
$ li ticket import -P -s pubsub.example.org ~/bugzilla_export.xml
|
||||
|
||||
Same import, but this time we want to map the field ``assigned_to_name`` from Bugzilla to
|
||||
the field ``assigned_to`` in our schema::
|
||||
|
||||
$ li ticket import -P -s pubsub.example.org -m assigned_to_name assigned_to ~/bugzilla_export.xml
|
||||
|
|
@ -41,13 +41,14 @@ The backend is a daemon, that means that it's a service running in the backgroun
|
|||
It takes its main configuration from a file named ``libervia.conf`` and can be in different
|
||||
locations (see below). It uses data in a directory called ``local_dir``, and which
|
||||
default, on suitable platforms, to the corresponding `XDG directory`_, which is most of
|
||||
time ``~/.local/share/sat``. In this directory, you'll find the main database in the
|
||||
``sat.db`` file, which is a `SQLite`_ database.
|
||||
time ``~/.local/share/libervia``. In this directory, you'll find the main database in the
|
||||
``libervia.db`` file, which is a `SQLite`_ database.
|
||||
|
||||
The backend is run and stopped with the ``sat`` executable. Running it without argument
|
||||
launch the backend in the background, with ``sat fg`` you run it in the foreground (you'll
|
||||
see log directly and can stop the backend with ``Ctrl + c``). The ``sat status`` commands
|
||||
help you discover if the backend is running or stopped.
|
||||
The backend is run and stopped with the ``libervia-backend`` executable. Running it
|
||||
without argument launch the backend in the background, with ``libervia-backend fg`` you
|
||||
run it in the foreground (you'll see log directly and can stop the backend with
|
||||
``Ctrl + c``). The ``libervia-backend status`` commands help you discover if the backend
|
||||
is running or stopped.
|
||||
|
||||
.. _XDG directory: https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
|
||||
.. _SQLite: https://sqlite.org
|
||||
|
|
|
|||
|
|
@ -147,12 +147,12 @@ class Exposed(base.CommandBase):
|
|||
id_group.add_argument(
|
||||
"name",
|
||||
nargs="?",
|
||||
help=_("name of the application to stop"),
|
||||
help=_("name of the application to check"),
|
||||
)
|
||||
id_group.add_argument(
|
||||
"-i",
|
||||
"--id",
|
||||
help=_("identifier of the instance to stop"),
|
||||
help=_("identifier of the instance to check"),
|
||||
)
|
||||
|
||||
async def start(self):
|
||||
|
|
|
|||
Loading…
Reference in a new issue