Skip to content

Commit

Permalink
doc: a few words about the translation server
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxKellermann committed Oct 23, 2023
1 parent bffadf5 commit 283cc2a
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Lukko loads the configuration file

The following top-level settings are recognized:

- ``translation_server``: consult this translation server to configure
child processes; must start with :file:`/` (absolute path) or
:file:`@` (abstract socket).
- ``translation_server``: consult this :ref:`translation server <ts>`
to configure child processes; must start with :file:`/` (absolute
path) or :file:`@` (abstract socket).


Listener
Expand Down Expand Up @@ -68,3 +68,27 @@ Known attributes:

- ``zeroconf_interface``: publish the Zeroconf service only on the
given interface.


.. _ts:

Translation Server
==================

Lukko can delegate certain decisions (user database, how to execute
commands) to a different process running on the same computer, called
a "translation server". This translation server may, for example,
consult a database to look up user accounts instead of reading
:file:`/etc/passwd` and can make complex decicions based on that data.
Only the translation server has access to all of Lukko's process
spawner features, which includes a light-weight container engine.

Information about the translation protocol can be found here:

- `documentation
<https://beng-proxy.readthedocs.io/en/latest/translation.html#login-translation>`__

- `definitions for C++ <https://github.com/CM4all/libcommon/blob/master/src/translation/Protocol.hxx>`__

- `asynchronous framework for C++
<https://github.com/CM4all/libcommon/tree/master/src/translation/server>`__

0 comments on commit 283cc2a

Please sign in to comment.