diff --git a/docs/reference/environment/docker.md b/docs/reference/environment/docker.md index ef7f724..0065e48 100644 --- a/docs/reference/environment/docker.md +++ b/docs/reference/environment/docker.md @@ -188,3 +188,22 @@ In cases if an [image](#property-image) needs to be pulled, either it does not e <> Holds the tag of the image to be downloaded. + + +### Examples {: #examples} + +1. Simple: + ```yaml + type: docker + ``` +2. With ubuntu image: + ```yaml + type: docker + image: ubuntu + ``` + +## Compatibility + +| <> | <> | +| - | - | +| <> | <> | diff --git a/docs/reference/environment/dummy.md b/docs/reference/environment/dummy.md new file mode 100644 index 0000000..ae026b5 --- /dev/null +++ b/docs/reference/environment/dummy.md @@ -0,0 +1,51 @@ +--- +description: An environment created for demonstration purposes, it simply prints a message and exists immediately. +toc_depth: 5 +--- + +# Dummy environment + +An environment created for demonstration purposes, it simply prints a message and exists immediately. + +This feature is usually only makes sense for cases where you want to create dummy configurations of Bifröst to demonstrate some functionality, like we're utilizing it in our demonstration configurations: [contrib/configurations/dummy-windows.yaml](<>). + + +## Configuration {: #configuration} + +<> +Has to be set to `dummy` to enable the dummy environment. + +<> +Will be displayed to the user upon connection to its environment. + +

Examples

+ +1. If [simple user](../authorization/simple.md) is used, show its name in a message: + ```yaml + banner: "Hello, {{.authorization.entry.name}}!\n" + ``` +2. If [users authorized via OIDC](../authorization/oidc.md) is used, show its name in a message: + ```yaml + banner: "Hello, {{.authorization.idToken.name}}!\n" + ``` + +<> +After [`banner`](#property-banner) was printed to the user, the environment will exit with this code. + +### Examples {: #examples} + +1. Simple: + ```yaml + type: simple + ``` +2. With message: + ```yaml + type: simple + banner: "Hello, {{.authorization.idToken.name}}!\n" + ``` + +## Compatibility + +| <> | <> | +| - | - | +| <> | <> | diff --git a/docs/reference/environment/index.md b/docs/reference/environment/index.md index 30dccc2..dcf0d39 100644 --- a/docs/reference/environment/index.md +++ b/docs/reference/environment/index.md @@ -10,6 +10,7 @@ Bifröst executes user sessions within environments. These environments can eith 1. `docker`: [Docker](docker.md) 2. `local`: [Local](local.md) +3. `dummy`: [Dummy](dummy.md) ## Examples diff --git a/docs/reference/environment/local.md b/docs/reference/environment/local.md index b1c9927..2a76107 100644 --- a/docs/reference/environment/local.md +++ b/docs/reference/environment/local.md @@ -320,9 +320,9 @@ If `true`, users are allowed to use SSH's port forwarding mechanism. }} ``` -## Compatibility +`## Compatibility | <> | <> | | - | - | | <> | <> | - +` diff --git a/mkdocs.yml b/mkdocs.yml index 88b40d3..e31d4e5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -150,6 +150,7 @@ nav: - reference/environment/index.md - Docker: reference/environment/docker.md - Local: reference/environment/local.md + - Dummy: reference/environment/dummy.md - Sessions: - reference/session/index.md - Filesystem: reference/session/fs.md