Mercurial > libervia-backend
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 |
rev | line source |
---|---|
4080 | 1 # Libervia |
0 | 2 |
4080 | 3 ### Copyrights |
0 | 4 |
4080 | 5 - Jérôme Poisson aka Goffi 2008-2023 |
6 - Adrien Cossa aka Souliane 2013-2016 | |
7 - Additional contributions by community members | |
0 | 8 |
4080 | 9 Libervia stands out as a one-of-a-kind XMPP (Jabber) client that brings you a |
10 comprehensive, multi-purpose, and multi-platform solution. It doesn't just focus on | |
11 instant messaging but offers an array of tools and features all in one place. | |
12 | |
13 ## License | |
0 | 14 |
4080 | 15 Libervia is a Libre software (Free as in "Freedom"), distributed under the AGPL v3+ |
16 license. For the full license, please refer to the `COPYING` file. | |
0 | 17 |
4080 | 18 ## Relevant URLs |
0 | 19 |
4080 | 20 Here are some useful URLs, all of which (except for the source code repository) are |
21 powered by Libervia itself, showcasing the flexibility and versatility of the tool: | |
0 | 22 |
4080 | 23 - Official Website: <https://libervia.org> |
24 - Documentation: <https://libervia.org/documentation> | |
25 - Bug Tracker: <https://libervia.org/tickets> | |
26 - Source Code: <https://repos.goffi.org/libervia-backend/> | |
27 - News: <https://libervia.org/news> (currently the same as the blog below) | |
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 | 30 Additionally, our blogs are accessible via ActivityPub thanks to the Libervia XMPP <=> |
31 ActivityPub gateway. | |
0 | 32 |
4080 | 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 | 35 Libervia is a unique XMPP client based on a daemon/frontends architecture. It supports |
36 multi-frontends (desktop, web, console interface, CLI, etc.) and provides a plethora of | |
37 multi-purpose tools such as instant messaging, microblogging, photo albums, calendar | |
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 | 40 Embedded within our DNA is a strong commitment to ethics. Our social contract provides |
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 | 43 This repository contains the "backend" of Libervia—the heart of the software. To use it, |
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 | 46 - [Libervia Web](https://repos.goffi.org/libervia-web/): Our flagship frontend, offering a |
47 potent, customizable social network for a broad spectrum of users—families, friends, | |
48 groups, associations, public services, companies, and more. | |
49 - [Libervia Desktop](https://repos.goffi.org/libervia-desktop/): Integrated with your | |
50 desktop, this frontend is under continual development. The existing | |
51 [Kivy](https://kivy.org/)-based version includes a prototype Android version, with an | |
52 upcoming iteration to be based on Qt. | |
53 - Libervia CLI: Bundled with Libervia Backend, our CLI is a true standout—one of the most | |
54 powerful XMPP CLIs out there. It's the go-to tool for quick tasks or crafting automation | |
55 scripts. | |
56 - Libervia TUI: Perfect for terminal enthusiasts or headless server operations, our TUI is | |
57 included with Libervia Backend. | |
0 | 58 |
59 | |
4080 | 60 Libervia can also function as an XMPP server component or a "generic" plugin. Currently, |
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 | 63 - An advanced file sharing component supporting [HTTP File |
64 Upload](https://xmpp.org/extensions/xep-0363.html), [Jingle File | |
65 Transfer](https://xmpp.org/extensions), file deletion, public link, access permission, | |
66 quotas, etc. | |
67 - An XMPP <=> ActivityPub Gateway, enabling users to interact with ActivityPub content | |
68 (from platforms like Mastodon, Pleroma, PeerTube, Mobilizon, etc.) as if they were XMPP | |
69 blogs or private messages, and vice versa. | |
0 | 70 |
4080 | 71 ## How To Use It? |
658 | 72 |
4080 | 73 For installation instructions and general documentation, please refer to the `doc` |
74 directory or visit <https://libervia.org/documentation/> | |
900 | 75 |
4080 | 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 | 82 |
4080 | 83 Tickets and merge requests are managed by Libervia itself using XMPP. For more |
84 information, visit <https://libervia.org/tickets> | |
2104 | 85 |
4080 | 86 ## Contact |
871 | 87 |
4080 | 88 Join us on the XMPP MUC room |
89 [libervia@chat.jabberfr.org](xmpp:libervia@chat.jabberfr.org?join) ([web | |
90 link](https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org)), or contact us | |
91 directly: | |
871 | 92 |
4080 | 93 - contact@salut-a-toi.invalid (replace `invalid` with `org`) |
94 - goffi@goffi.invalid (email, replace `invalid` with `org`) | |
0 | 95 |
96 This software is dedicated to Roger Poisson. |