Mercurial > libervia-backend

comparison doc/overview.rst @ 4249:ba46d6a0ff3a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: style/typos/URL fixes
author Goffi <goffi@goffi.org>
date Fri, 31 May 2024 11:08:20 +0200
parents 7fe1028acab2
children
comparison
equal deleted inserted replaced
4248:00852dd54695 4249:ba46d6a0ff3a
155 parameters) even if this is not usual. 155 parameters) even if this is not usual.
156 156
157 On a Libervia installation used by a single user, the profiles are usually used for multiple 157 On a Libervia installation used by a single user, the profiles are usually used for multiple
158 accounts. On a multi-users installations, there is usually one profile per user. 158 accounts. On a multi-users installations, there is usually one profile per user.
159 159
160 When you connect to a Libervia frontend, you need to specify a profile and the associated password. The profile password is not the same as the password of the XMPP account. While this may sounds confusing, there are several reason why we use this notion of profile instead of directly the XMPP account/password: 160 When you connect to a Libervia frontend, you need to specify a profile and the associated
161 password. The profile password is not the same as the password of the XMPP account. While
162 this may sounds confusing, there are several reason why we use this notion of profile
163 instead of directly the XMPP account/password:
161 164
162 - Libervia needs to know the plain XMPP password to connect, and it is encrypted in database. 165 - Libervia needs to know the plain XMPP password to connect, and it is encrypted in database.
163 The profile password is used to encrypt/decrypt it, this way only a `password hash`_ is 166 The profile password is used to encrypt/decrypt it, this way only a `password hash`_ is
164 stored and the XMPP password is encrypted `at rest`_. 167 stored and the XMPP password is encrypted `at rest`_.
165 168
176 179
177 - a profile is a simple name associated with an account, it's easier to remember than a 180 - a profile is a simple name associated with an account, it's easier to remember than a
178 whole XMPP identifier (also named "JID" for *Jabber ID*) 181 whole XMPP identifier (also named "JID" for *Jabber ID*)
179 182
180 You always have a *default* profile which is the profile used when you don't select any 183 You always have a *default* profile which is the profile used when you don't select any
181 (notably used in jp). This is the first profile that you have created except if you have 184 (notably used in Libervia CLI). This is the first profile that you have created except if
182 changed it using a frontend (you can change it with jp). 185 you have changed it using a frontend (you can change it with Libervia CLI).
183 186
184 .. _password hash: https://en.wikipedia.org/wiki/Key_derivation_function 187 .. _password hash: https://en.wikipedia.org/wiki/Key_derivation_function
185 .. _at rest: https://en.wikipedia.org/wiki/Data_at_rest 188 .. _at rest: https://en.wikipedia.org/wiki/Data_at_rest
186 189
187 profile key 190 profile key
217 220
218 Most of the frontends use images or other media. To avoid duplication and to make the code 221 Most of the frontends use images or other media. To avoid duplication and to make the code
219 repositories lighter, those media are grouped in a separate repository. The Libervia media 222 repositories lighter, those media are grouped in a separate repository. The Libervia media
220 repository is available at https://repos.goffi.org/sat_media. You can also download media 223 repository is available at https://repos.goffi.org/sat_media. You can also download media
221 at https://ftp.goffi.org/sat_media/sat_media.tar.bz2. The path where Libervia media are 224 at https://ftp.goffi.org/sat_media/sat_media.tar.bz2. The path where Libervia media are
222 installed must be specified in ``libervia.conf`` in ``media_dir`` option of the ``[DEFAULT`` 225 installed must be specified in ``libervia.conf`` in ``media_dir`` option of the ``[DEFAULT]``
223 section. 226 section.
224 227
225 Libervia Templates 228 Libervia Templates
226 ------------------ 229 ------------------
227 230
228 Libervia embeds a `Jinja2`_ template engine (see `Libervia Web`_ above). "Libervia templates" refers to 231 Libervia embeds a `Jinja2`_ template engine (see `Libervia Web`_ above). "Libervia
229 the default templates (i.e. the official templates, the ones used in default Libervia pages). Those template may also be used by other frontends than Libervia (jp can use them with the :ref:`libervia-cli_output` arguments). 232 templates" refers to the default templates (i.e. the official templates, the ones used in
230 233 default Libervia pages). Those template may also be used by other frontends than Libervia
231 Libervia templates repository is available at https://repos.goffi.org/sat_templates, they can 234 (Libervia CLI can use them with the :ref:`libervia-cli_output` arguments).
232 also be downloaded at `PyPI <https://pypi.org/project/sat-templates/>`_ and will be 235
236 Libervia templates repository is available at https://repos.goffi.org/libervia-templates, they can
237 also be downloaded at `PyPI <https://pypi.org/project/libervia-templates/>`_ and will be
233 installed automatically if you install Libervia. 238 installed automatically if you install Libervia.
234 239
235 Related projects 240 Related projects
236 ================ 241 ================
237 242
242 --------------- 247 ---------------
243 248
244 Numerous features of Libervia are taking profit of `PubSub`_ functionalities of XMPP. 249 Numerous features of Libervia are taking profit of `PubSub`_ functionalities of XMPP.
245 Because PubSub implementations in the wild are not all on the same level, and some 250 Because PubSub implementations in the wild are not all on the same level, and some
246 experimental features are sometimes explored, a PubSub service as been written 251 experimental features are sometimes explored, a PubSub service as been written
247 specifically for the needs of Libervia (but it's not depending on Libervia and any XMPP software can 252 specifically for the needs of Libervia (but it's not depending on Libervia and any XMPP
248 use it). 253 software can use it).
249 254
250 Libervia PubSub aims to be a feature complete, server-independent PubSub implementation, and 255 Libervia PubSub aims to be a feature complete, server-independent PubSub implementation, and
251 try to be up-to-date with latest XMPP PubSub extensions. It is the privileged service to 256 try to be up-to-date with latest XMPP PubSub extensions. It is the privileged service to
252 use with Libervia because it supports everything needed (but Libervia can work with any XMPP PubSub 257 use with Libervia because it supports everything needed (but Libervia can work with any XMPP PubSub
253 service, it will adapt itself to available features). 258 service, it will adapt itself to available features).
297 .. _mod_delegation: https://modules.prosody.im/mod_delegation.html 302 .. _mod_delegation: https://modules.prosody.im/mod_delegation.html
298 303
299 Libervia official website 304 Libervia official website
300 ------------------------- 305 -------------------------
301 306
302 The official website is made with Libervia web framework. You'll find it at https://repos.goffi.org/sat_web_site 307 The official website is made with Libervia web framework. You'll find it at https://repos.goffi.org/libervia-website
303 308
304 Salut 309 Salut
305 ----- 310 -----
306 Probably the smaller side project used by Libervia, it is a simple users directory (registration must be done explicitly by users) using `XEP-0055`_ (Jabber Search). 311 Probably the smaller side project used by Libervia, it is a simple users directory (registration must be done explicitly by users) using `XEP-0055`_ (Jabber Search).
307 312