Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lslezak committed Dec 12, 2023
1 parent 54aeb0d commit 58a10f7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion web/src/context/installerL10n.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit 58a10f7

Please sign in to comment.