Mercurial > libervia-backend

comparison README.md @ 4080:0ea6b34f8f18

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: README rewrite: - markdown is now used instead of plain text - updated text - contributors and credits have been moved to ACKNOWLEDGMENTS.md (but they are outdated)
author Goffi <goffi@goffi.org>
date Tue, 06 Jun 2023 13:42:00 +0200
parents README@be6d91572633
children
comparison
equal deleted inserted replaced
4079:10b6ad569157 4080:0ea6b34f8f18
1 # Libervia
2
3 ### Copyrights
4
5 - Jérôme Poisson aka Goffi 2008-2023
6 - Adrien Cossa aka Souliane 2013-2016
7 - Additional contributions by community members
8
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
14
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.
17
18 ## Relevant URLs
19
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:
22
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/>
29
30 Additionally, our blogs are accessible via ActivityPub thanks to the Libervia XMPP <=>
31 ActivityPub gateway.
32
33 ## About
34
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.
39
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`.
42
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:
45
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.
58
59
60 Libervia can also function as an XMPP server component or a "generic" plugin. Currently,
61 we offer two components:
62
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.
70
71 ## How To Use It?
72
73 For installation instructions and general documentation, please refer to the `doc`
74 directory or visit <https://libervia.org/documentation/>
75
76 ## Contributions
77
78 Here are the URIs you can use to publish/retrieve tickets or merge requests:
79
80 - Tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "core"
81 label)
82 - Merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please
83 use "core" label)
84
85 Tickets and merge requests are managed by Libervia itself using XMPP. For more
86 information, visit <https://libervia.org/tickets>
87
88 ## Contact
89
90 Join us on the XMPP MUC room
91 [libervia@chat.jabberfr.org](xmpp:libervia@chat.jabberfr.org?join) ([web
92 link](https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org)), or contact us
93 directly:
94
95 - contact@salut-a-toi.invalid (replace `invalid` with `org`)
96 - goffi@goffi.invalid (email, replace `invalid` with `org`)
97
98 This software is dedicated to Roger Poisson.