annotate README.md @ 4334:111dce64dcb5

plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Pydantic models are used more and more in Libervia, for the bridge API, and also to convert `domish.Element` to internal representation. Type hints have also been added in many places. rel 453
author Goffi <goffi@goffi.org>
date Tue, 03 Dec 2024 00:12:38 +0100
parents cb32d8c6a040
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
1 # Libervia
0
goffi@necton2
parents:
diff changeset
2
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
3 ### Copyrights
0
goffi@necton2
parents:
diff changeset
4
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
5 - Jérôme Poisson aka Goffi 2008-2023
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
6 - Adrien Cossa aka Souliane 2013-2016
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
7 - Additional contributions by community members
0
goffi@necton2
parents:
diff changeset
8
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
9 Libervia stands out as a one-of-a-kind XMPP (Jabber) client that brings you a
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
10 comprehensive, multi-purpose, and multi-platform solution. It doesn't just focus on
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
11 instant messaging but offers an array of tools and features all in one place.
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
12
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
13 ## License
0
goffi@necton2
parents:
diff changeset
14
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
15 Libervia is a Libre software (Free as in "Freedom"), distributed under the AGPL v3+
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
16 license. For the full license, please refer to the `COPYING` file.
0
goffi@necton2
parents:
diff changeset
17
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
18 ## Relevant URLs
0
goffi@necton2
parents:
diff changeset
19
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
20 Here are some useful URLs, all of which (except for the source code repository) are
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
21 powered by Libervia itself, showcasing the flexibility and versatility of the tool:
0
goffi@necton2
parents:
diff changeset
22
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
23 - Official Website: <https://libervia.org>
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
24 - Documentation: <https://libervia.org/documentation>
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
25 - Bug Tracker: <https://libervia.org/tickets>
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
26 - Source Code: <https://repos.goffi.org/libervia-backend/>
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
27 - News: <https://libervia.org/news> (currently the same as the blog below)
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
28 - Main Developer's Blog: <https://www.goffi.org/>
238
83d2bc0abf2a version, README, CHANGELOG and INSTALL updates
Goffi <goffi@goffi.org>
parents: 228
diff changeset
29
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
30 Additionally, our blogs are accessible via ActivityPub thanks to the Libervia XMPP <=>
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
31 ActivityPub gateway.
0
goffi@necton2
parents:
diff changeset
32
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
33 ## About
626
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27.
Goffi <goffi@goffi.org>
parents: 614
diff changeset
34
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
35 Libervia is a unique XMPP client based on a daemon/frontends architecture. It supports
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
36 multi-frontends (desktop, web, console interface, CLI, etc.) and provides a plethora of
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
37 multi-purpose tools such as instant messaging, microblogging, photo albums, calendar
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
38 events, file sharing, A/V calls, and state-of-the-art end-to-end encryption.
626
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27.
Goffi <goffi@goffi.org>
parents: 614
diff changeset
39
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
40 Embedded within our DNA is a strong commitment to ethics. Our social contract provides
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
41 insight into these principles - refer to `CONTRAT_SOCIAL` or `CONTRAT_SOCIAL_en`.
626
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27.
Goffi <goffi@goffi.org>
parents: 614
diff changeset
42
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
43 This repository contains the "backend" of Libervia—the heart of the software. To use it,
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
44 you will need to install one or more frontends:
626
190ccc6dc36c doc: added instructions to launch D-Bus on a terminal environment, as requested in bug 27.
Goffi <goffi@goffi.org>
parents: 614
diff changeset
45
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
46 - [Libervia Web](https://repos.goffi.org/libervia-web/): Our flagship frontend, offering a
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
47 potent, customizable social network for a broad spectrum of users—families, friends,
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
48 groups, associations, public services, companies, and more.
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
49 - [Libervia Desktop](https://repos.goffi.org/libervia-desktop/): Integrated with your
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
50 desktop, this frontend is under continual development. The existing
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
51 [Kivy](https://kivy.org/)-based version includes a prototype Android version, with an
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
52 upcoming iteration to be based on Qt.
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
53 - Libervia CLI: Bundled with Libervia Backend, our CLI is a true standout—one of the most
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
54 powerful XMPP CLIs out there. It's the go-to tool for quick tasks or crafting automation
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
55 scripts.
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
56 - Libervia TUI: Perfect for terminal enthusiasts or headless server operations, our TUI is
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
57 included with Libervia Backend.
0
goffi@necton2
parents:
diff changeset
58
goffi@necton2
parents:
diff changeset
59
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
60 Libervia can also function as an XMPP server component or a "generic" plugin. Currently,
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
61 we offer two components:
1541
685fad1c18e4 README, README4PACKAGERS: some update about third party modules.
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
62
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
63 - An advanced file sharing component supporting [HTTP File
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
64 Upload](https://xmpp.org/extensions/xep-0363.html), [Jingle File
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
65 Transfer](https://xmpp.org/extensions), file deletion, public link, access permission,
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
66 quotas, etc.
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
67 - An XMPP <=> ActivityPub Gateway, enabling users to interact with ActivityPub content
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
68 (from platforms like Mastodon, Pleroma, PeerTube, Mobilizon, etc.) as if they were XMPP
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
69 blogs or private messages, and vice versa.
0
goffi@necton2
parents:
diff changeset
70
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
71 ## How To Use It?
658
e26134122ed7 misc: added Dal to contributors
Goffi <goffi@goffi.org>
parents: 640
diff changeset
72
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
73 For installation instructions and general documentation, please refer to the `doc`
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
74 directory or visit <https://libervia.org/documentation/>
900
21681070f913 misc: added Naha to README
Goffi <goffi@goffi.org>
parents: 887
diff changeset
75
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
76 ## Contributions
2549
f685ad80ee98 README: specified URIs location for tickets and merge requests
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
77
f685ad80ee98 README: specified URIs location for tickets and merge requests
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
78 Here are the URIs you can use to publish/retrieve tickets or merge requests:
f685ad80ee98 README: specified URIs location for tickets and merge requests
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
79
4330
cb32d8c6a040 README: Put tickets and MR data on a single line:
Goffi <goffi@goffi.org>
parents: 4080
diff changeset
80 - Tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "core" label)
cb32d8c6a040 README: Put tickets and MR data on a single line:
Goffi <goffi@goffi.org>
parents: 4080
diff changeset
81 - Merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "core" label)
2557
f2a829bbdbb5 README: minor line addition
Goffi <goffi@goffi.org>
parents: 2555
diff changeset
82
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
83 Tickets and merge requests are managed by Libervia itself using XMPP. For more
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
84 information, visit <https://libervia.org/tickets>
2104
4f189bd1d9ed misc: README update
Goffi <goffi@goffi.org>
parents: 2025
diff changeset
85
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
86 ## Contact
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
87
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
88 Join us on the XMPP MUC room
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
89 [libervia@chat.jabberfr.org](xmpp:libervia@chat.jabberfr.org?join) ([web
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
90 link](https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org)), or contact us
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
91 directly:
871
5d08ab99e8dd README and INSTALL updates
Goffi <goffi@goffi.org>
parents: 816
diff changeset
92
4080
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
93 - contact@salut-a-toi.invalid (replace `invalid` with `org`)
0ea6b34f8f18 doc: README rewrite:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
94 - goffi@goffi.invalid (email, replace `invalid` with `org`)
0
goffi@necton2
parents:
diff changeset
95
goffi@necton2
parents:
diff changeset
96 This software is dedicated to Roger Poisson.