Mercurial > libervia-backend

view misc/README @ 4212:5f2d496c633f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 a27fd445c7c7
children
line wrap: on
line source

This directory contains files related to Libervia but not directly used by it.

* file _li:
    This is the completion file for zsh. To use it, you need to have it in a path accessible in your fpath variable, and to have completion activated. This can be done by the following commands in your .zshrc:

### .zshrc completion ###
fpath=(/path/to/directory/with/_li/ $fpath)
autoload -U compinit
compinit
### end of .zshrc completion ###

    Then, you should be able to complete a li command line by pressing [TAB].

* org.libervia.Libervia.service:
	This file is used by D-Bus to know how to launch the backend, you have to put in in D-Bus services dir (usually /usr/share/dbus-1/services)

* org.libervia.Libervia*.metainfo.xml:
	AppStream metadata as specified at https://www.freedesktop.org/software/appstream/docs/

* org.libervia.LiberviaTUI.desktop:
	Desktop entry for TUI frontend as specified at https://specifications.freedesktop.org/desktop-entry-spec/