Mercurial > libervia-backend
view 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 |
line wrap: on
line source
====================== Libervia documentation ====================== Welcome to Libervia's documentation. You'll find here both end-user and developer documentations. Libervia is a Libre communication ecosystem based on XMPP standard. It allows you to do many things such as: - instant messaging - (micro)blogging - file sharing - managing photo albums - organizing/managing events - handling tasks - etc. It features many interfaces (desktop, mobile, web, command line, console), and is multi-platforms. 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>`_) .. toctree:: :caption: Contents: :maxdepth: 3 installation.rst overview.rst configuration.rst encryption.rst components.rst developer.rst /libervia-cli/index.rst /libervia-tui/index.rst /contributing/index.rst Indices and tables ================== * :ref:`genindex` * :ref:`search`