Commit graph libervia-backend/doc
Author SHA1 Message Date
Goffi
1003cd2c6d doc (conf.py): update project name and exclude the TUI documentation 2026-11-04 09:47:04 +01:00
Goffi
0805f77f45 doc (overview, libervia-tui): rename "Primitivus" to "Libervia TUI":
The TUI documentation was still using the legacy name. The reference in the overview is
also commented out, as the TUI is temporarily broken.
2026-11-04 09:47:04 +01:00
Goffi
441e9cec52 doc: minors updates 2026-11-04 09:47:04 +01:00
Goffi
40fef895ba doc (cli): add isolation (-i/--isolation) documentation 2026-11-04 09:47:04 +01:00
Goffi
b51b942103 doc (how-tos/email gateway): update the email gateway how-to:
pdate the gateway how-to to follow changes in configuration:
- configure the component with the simplifiedi configuration (`[component.email_gateway]`)
- remove the "supported features" section (redundant with email gateway documentation in
  `components.rst`)
2026-11-04 09:47:04 +01:00
Goffi
0c955f6abd doc (apps): fix the apps documentation:
The page was a messy reference, with several fields missing or incomplete. It is now
completed and easier to read.
2026-11-04 09:47:04 +01:00
Goffi
fc0a385027 doc (components): document the common component settings:
- Move the `ComponentSettings` autodoc from "Simplified Component Configuration" to a new
  "Common Component Settings" section. This was confusing when most of time only `jid` and
  `secret` are needed.
- Document the config section naming (dashes replaced by underscores) and how to run a
  component in an isolated instance (systemd, `li -i`).
- Fix the `[components.X]` section names (`[component.X]`).
2026-11-04 09:47:04 +01:00
Goffi
cb9af3881e doc (testing): move the testing documentation to its own page:
Testing is now in the "Developer" section of the index, and the `contributing/` directory
is removed (redundant).
2026-11-04 09:47:04 +01:00
Goffi
184718e3ed doc (installation): update/rewrite of installation instructions:
- We are now using `uv`, so documentation has been updated accordingly.
- Commented out instruction on unmaintained things (AUR packages, TUI).
- Add instructions on using systemd services.
2026-11-04 09:47:04 +01:00
Goffi
2af29e7999 doc (configuration): update (and rewrite for TOML):
- Configuration is now made with TOML, and the documentation was outdated. It has been
  rewritten for TOML, and autodoc is used to show configuration options available in code
  (and keep it up-to-date).
- New isolation mode is documentated.
- (core/constants): fix the `tmp` isolation mode to inherits the parent configuration like
  `normal`.
2026-11-03 18:02:05 +01:00
Goffi
388c451288 doc: reorganise index:
Index is reorganised to have separated `content`, `developer` and `how-tos` sections.

The TUI documentation is temporarily disabled (as TUI is currently broken).
2026-11-03 18:02:05 +01:00
Goffi
8b0aa646fc doc (components): fix XEP-0442 title 2026-10-26 18:36:41 +01:00
Goffi
45024d913e doc (howto backup, cli/backup): document the new backup mechanism:
Add a "How-To" for backup, and document the new `backup` commands

fix 480
2026-09-15 11:48:11 +02:00
Goffi
33132827f3 cli (application): new update command:
Update an application, or all of them.
2026-07-21 11:50:20 +02:00
Goffi
53a83b6042 doc (cli/serverless): serverless commands documentation:
Document the commands `discover` and `info`.

fix 479
2026-07-17 23:27:47 +02:00
Goffi
8bc3b4156a doc (component): the section use a . now 2026-06-19 12:14:54 +02:00
Goffi
84e92f9a98 doc (cli): Document xid commands:
fix 477
2026-06-06 12:36:14 +02:00
Goffi
f03939e2af doc (components/pubsub): Pubsub component documentation:
fix 476
2026-04-15 22:15:46 +02:00
Goffi
e7c508b11c doc (components): Update Tigase doc URL (former was a dead link) 2026-04-15 22:15:18 +02:00
Goffi
68da01a043 Dates update. 2026-03-31 12:57:17 +02:00
Goffi
82e2c6efac apply black to the whole codebase. 2026-03-09 09:22:04 +01:00
Goffi
3cf38d138e doc (cli/contacts): Add documentation for contacts:
describe the new `contacts` commands to handle pubsub contacts.

fix 475
2026-02-23 13:15:16 +01:00
Goffi
8805f63b1f plugins XEP-0473, XEP-0475, XEP-0477: rename plugins from prototype name to XEP number + doc update:
Plugin for pubsub encryption and signing were named using prototype name as the
specifications where not yet published at the time. Since, those specifications have been
accepted, so we can rename those plugins using the corresponding XEP numbers.

Doc has been updated to remove old mention saying that the XEP was still being evaluated.

rel 475
2026-02-23 12:56:42 +01:00
Goffi
a8ef17c5f8 doc(tor, cli/info): Add documentation on Tor feature:
- Add `autodoc_pydantic` dependency for `docs`, it renders nicely Pydantic models,
  including the settings.
- Add documentation for `li info tor`
- Add a dedicated section on Tor

fix 473
2025-12-15 11:44:26 +01:00
Goffi
6a7b7bc36a core: Replace legacy INI config system with Pydantic-based TOML configuration.
This is a huge configuration refactoring.

The configuration system now uses Pydantic settings, with better validation, better
support for environment variables and other goodies.

The main config files now use TOML instead of INI, this allow for better handling of
complex types, notably dict.

Plugins, components and frontends can declare their config settings in a class which will
be imported dynamically.
2025-11-30 12:27:35 +01:00
Goffi
4346278bd8 doc (cli/call): Update doc with new features:
Add doc for:

- `no_ui` output
- stdin/stdout redirection
- custom GStreamer pipelines
2025-11-19 18:03:07 +01:00
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