From 58a10f7cdbb61ec7969fad2f395eed7c9d981498 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Tue, 12 Dec 2023 14:43:40 +0100 Subject: [PATCH] update documentation --- web/README.md | 12 ++++++++++++ web/src/context/installerL10n.jsx | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/web/README.md b/web/README.md index f31aba25f..96dae571e 100644 --- a/web/README.md +++ b/web/README.md @@ -69,6 +69,18 @@ Where `COCKPIT_TARGET` is the IP address or hostname of the running Agama instance. This is especially useful if you use the Live ISO which does not contain any development tools, you can develop the web frontend easily from your workstation. +### Special Environment Variables + +`COCKPIT_TARGET` - When running the development server set up a proxy to the +specified Cockpit server. See the [using a development +server](#using-a-development-server) section above. + +`LOCAL_CONNECTION` - Force behaving as in a local connection, useful for +development or testing some Agama features. For example the keyboard layout +switcher is displayed only in local installation because it cannot work in +remote connection. This option will force displaying it even in a remote +connection. + ## JSDoc Documentation This project uses [TypeDoc](https://typedoc.org/) to generate the API documentation. The `jsdoc` diff --git a/web/src/context/installerL10n.jsx b/web/src/context/installerL10n.jsx index 33edb3fce..7c8b85ae7 100644 --- a/web/src/context/installerL10n.jsx +++ b/web/src/context/installerL10n.jsx @@ -180,7 +180,7 @@ function reload(newLanguage) { } /** - * Extracts keymap from localectl output. + * Extracts the keymap from the `setxkbmap -query` output. * * @param {string} output * @returns {string|undefined}