Mercurial > libervia-backend
annotate doc/index.rst @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 23 Feb 2024 13:31:04 +0100 |
parents | d6837db456fd |
children |
rev | line source |
---|---|
3505 | 1 ====================== |
2 Libervia documentation | |
3 ====================== | |
2946 | 4 |
3505 | 5 Welcome to Libervia's documentation. You'll find here both end-user and developer documentations. |
2946 | 6 |
3505 | 7 Libervia is a Libre communication ecosystem based on XMPP standard. It allows you to do many things such as: |
2946 | 8 |
9 - instant messaging | |
10 - (micro)blogging | |
11 - file sharing | |
12 - managing photo albums | |
13 - organizing/managing events | |
14 - handling tasks | |
15 - etc. | |
16 | |
17 It features many interfaces (desktop, mobile, web, command line, console), and is multi-platforms. | |
18 | |
4077
d6837db456fd
refactoring: fix names in doc following modules hierarchy refactoring
Goffi <goffi@goffi.org>
parents:
3950
diff
changeset
|
19 You can follow this documentation to learn more on it, or join our official XMPP room at `libervia@chat.jabberfr.org <xmpp:libervia@chat.jabberfr.org?join>`_ (also available via a `web link <https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org>`_) |
2946 | 20 |
21 | |
22 .. toctree:: | |
23 :caption: Contents: | |
24 :maxdepth: 3 | |
25 | |
26 installation.rst | |
3021
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
27 overview.rst |
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
28 configuration.rst |
3950
8f87ff449a34
doc: new doc giving an overview on how e2ee is working in Libervia/XMPP:
Goffi <goffi@goffi.org>
parents:
3681
diff
changeset
|
29 encryption.rst |
3678 | 30 components.rst |
3606
25d3677701e7
doc: developer documentation explaining storage and pubsub cache
Goffi <goffi@goffi.org>
parents:
3505
diff
changeset
|
31 developer.rst |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3430
diff
changeset
|
32 /libervia-cli/index.rst |
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3430
diff
changeset
|
33 /libervia-tui/index.rst |
3645 | 34 /contributing/index.rst |
2946 | 35 |
36 | |
37 Indices and tables | |
38 ================== | |
39 | |
40 * :ref:`genindex` | |
41 * :ref:`search` |