erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
4,441 commits 2 branches 0 tags 65 MiB
Commit graph libervia-backend/doc
Author SHA1 Message Date
Goffi
d2f4623b53 doc: Add How-To for Email Gateway: 
This How-To complete installation instruction with an easy-to follow document to
completely install the Email <=> XMPP gateway.

fix 466
 2025-10-10 17:44:04 +02:00
Goffi
c1cb70ac1a doc (installation): Update instructions: 
- Instructions have been checked and updated. OS packages dependencies have been added for
  Arch Linux.
- Added missing package.
- Reordered/refreshed instructions.
- Old/not relevant content has been removed.
- Tested on latest docker images of Debian/Arch/Unbutu.

rel 466
 2025-10-10 17:44:04 +02:00
Goffi
96bf3af324 Global reformatting with black. 2025-09-13 10:46:10 +02:00
Goffi
5ec4fdd787 doc (components): Add message cleaning section to email gateway doc: 
fix 464
 2025-09-11 21:17:51 +02:00
Goffi
b816dc5e54 cli (pubsub): List support first draft + doc: 
Basic support for listing hierarchy of nodes with pubsub extended discovery. Nodes are
displayed as a tree, depth can be specified.

rel 463
 2025-08-31 12:34:37 +02:00
Goffi
009ef1aa4b doc (components): Document the handling of mailing lists in Email Gateway: 
fix 462
 2025-08-03 23:45:48 +02:00
Goffi
2346dfb461 doc (components, encryption): add documentation on autocrypt for client and email gateway: 
fix 456
 2025-02-28 09:23:35 +01:00
Goffi
55e4d0bc48 doc (component): document use of Gateway Relayed Encryption: 
fix 455
 2025-01-13 01:23:22 +01:00
Goffi
67208fb87e doc (components): Update Email Gateway documentation: 
A section has been added to explain how attachments are handled.

fix 453
 2024-12-03 00:53:18 +01:00
Goffi
33edd87271 doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc. 2024-11-20 11:49:46 +01:00
Goffi
3a5f1b5cd4 doc (components): update doc to show headers support: 
fix 451
 2024-09-28 16:00:16 +02:00
Goffi
03f8421e84 doc (components): update doc to indicate support of addressing metadata. 
fix 450
 2024-09-26 16:12:01 +02:00
Goffi
c1ed8306ae doc (cli/message): add documentation for new addressing commands: 
rel 450
 2024-09-26 16:12:01 +02:00
Goffi
42263d05f9 doc (components): new Email gateway documentation: 
fix 449
 2024-09-06 18:07:44 +02:00
Goffi
cf0363a3af doc (cli): documentation for new gateway command: 
rel 449
 2024-09-06 18:03:36 +02:00
Goffi
f8d383258c doc (encryption): update pubsub encryption specifications. 2024-07-13 17:45:47 +02:00
Goffi
6f347a3fb1 doc (components): Documentation for the new Conferences component: 
fix 445
 2024-07-05 17:18:37 +02:00
Goffi
eb00eb4b71 doc (configuration): replace deprecated SafeConfigParser. 2024-06-12 22:33:10 +02:00
Goffi
5a0a68e358 doc (components/AP Gateway): document new http_sign_get configuration option. 2024-06-05 22:34:43 +02:00
Goffi
4e1f991e3b doc (installation): use [all] in extra arguments. 2024-06-05 22:24:18 +02:00
Goffi
4c7d4de032 doc: style/typos/URL fixes 2024-05-31 11:08:20 +02:00
Goffi
b1b2fe1aa8 doc: documentation to create a Libervia app, first draft 2024-05-31 11:08:18 +02:00
Goffi
ba7cec65a0 doc (cli): remote-control documentation 
Document the new remote control commands.

rel 436
 2024-05-11 13:52:43 +02:00
Goffi
146dd6022f doc (contributing/testing): typo 2024-02-23 15:47:53 +01:00
Goffi
672f967080 doc (cli/call): add `tui` output, and document options: 
fix 428
 2024-02-16 18:46:06 +01:00
Goffi
40ababcf9c doc (cli/call): add outputs documentation: 
outputs are now documentated, and notably the new `gui` one.

fix 427
 2024-02-11 23:22:18 +01:00
Goffi
b634e41ac0 core, doc, cli (forums): new forums set commands + doc: 
- document the fact that if an empty `uri` is used, the forum node is created
  automatically
- new `forums/set` CLI commands and its documentation
 2023-12-11 18:10:27 +01:00
Goffi
d80c4e89dc plugin XEP-0277, doc: conflict is now checked and avoided if user_friendly_id_suffix is False, doc updated 2023-12-05 13:39:03 +01:00
Goffi
3c6cd70c80 doc (cli/blog): Document new --alt-link option 2023-12-05 13:14:55 +01:00
Goffi
e3370c0a00 doc (cli/blog): documentation of the new --no-id-suffix option. 2023-12-05 13:13:03 +01:00
Goffi
d96ca8443b doc (cli): documentation for the new call command: 
fix 426
 2023-11-01 14:10:31 +01:00
Goffi
ba3f96672f doc (cli): notification commands documentation. 2023-10-18 15:33:46 +02:00
Goffi
0e6dd6a8de doc (installation): update pipx instruction and remove requirements.txt mention 2023-08-09 00:48:11 +02:00
Goffi
75c8868620 doc (conf): fix version retrieval 2023-06-23 15:19:06 +02:00
Goffi
7e3834a5e9 refactoring: fix names in doc following modules hierarchy refactoring 2023-06-02 17:38:37 +02:00
Goffi
6a6f15707a massive refactoring to switch from camelCase to snake_case: 
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
 2023-04-08 13:54:42 +02:00
Goffi
d50412c7f7 dpc (cli/info): update "disco" documentation to include new "external services": 
fix 418
 2023-04-07 15:18:39 +02:00
Goffi
217d49918d doc[installation]: update instructions 2022-11-24 12:25:07 +01:00
Goffi
5eae9dc299 doc (components): typo 2022-11-22 11:53:31 +01:00
Goffi
14eac027d8 doc (components/AP Gateway): html_redirect_dict option 2022-11-11 13:51:22 +01:00
Goffi
dd434fbf1f doc (encryption, cli): document Pubsub Targeted Encryption: 
a small section has been added to `encryption` to explain the difference with OXPS, and
the `--encrypt-for` arguments are explained.

fix 382
 2022-10-31 13:50:12 +01:00
Goffi
289855c9d1 doc (encryption, cli): pubsub signing documentation: 
- add a `Pubsub Signature` section to `encryption` documentation
- document `-X, --sign` flag where it's used
- document `pubsub/signature` subcommands

fix 381
 2022-10-30 01:06:58 +02:00
Goffi
39181f0bff doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling: 
fix 380
 2022-10-15 20:38:33 +02:00
Goffi
3ead662a51 doc: new doc giving an overview on how e2ee is working in Libervia/XMPP: 
the doc explain pubsub e2ee for now

rel 380
 2022-10-15 20:38:33 +02:00
Goffi
6eac59dc2d doc (components/AP Gateway): Ad-Hoc and Events: 
New Ad-Hoc command is explained, and `Events` section specify how the conversion is done
between the 2 protocols.

fix 372
 2022-09-22 12:03:12 +02:00
Goffi
b06f5cad04 doc (cli/event): update doc following changes: 
rel 372
 2022-09-22 12:01:44 +02:00
Goffi
84e6d9ceb2 doc (components/AP gateway): "reactions": 
fix 371
 2022-08-31 17:07:03 +02:00
Goffi
c7acfc1b9f doc (components): the word "handle" is more adapted here 2022-08-31 17:07:03 +02:00
Goffi
6bb76a2bd0 doc (components/AP gateway): "repeat" and "noticed/like": 
fix 370
 2022-07-22 17:40:03 +02:00
Goffi
4b8e1c2747 doc (cli/pubsub, cli/blog): attachments subcommands documentation: 
rel 370
 2022-07-22 17:16:28 +02:00