Skip to content

Commit

Permalink
docs: add feature flag update instructions (#6583)
Browse files Browse the repository at this point in the history
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
  • Loading branch information
ossdhaval authored and devrimyatar committed Dec 30, 2023
1 parent bc0b5f4 commit 7c29339
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 2 deletions.
3 changes: 1 addition & 2 deletions docs/admin/config-guide/config-tools/jans-tui/README.md
Expand Up @@ -8,7 +8,7 @@ tags:
- text base UI
---

## Overview
# TUI - Text based User Interface

The "Text User Interface" or "TUI" is a tool for admins to perform *ad
hoc* configuration of the Janssen Project software components.
Expand All @@ -17,7 +17,6 @@ You can run it by executing:

```
/opt/jans/jans-cli/jans_cli_tui.py
```

The TUI calls the Jans Config API. A TUI client is configured out of the
Expand Down
11 changes: 11 additions & 0 deletions docs/admin/config-guide/config-tools/jans-tui/navigation-guide.md
Expand Up @@ -5,8 +5,11 @@ tags:
- tools
- tui
- text base UI
- navigation
---

# TUI Navigation Guide

## General Structure:

1. The TUI consists of many tabs, each tab may or may not contain nested tabs.
Expand Down Expand Up @@ -178,3 +181,11 @@ can be used to delete a certain label

![image](https://user-images.githubusercontent.com/63171603/216968417-4cb15f2a-f01c-48bb-a27d-e4e73edb8082.png)

## Logout and Exit

Exit will close the TUI screen while logout will force re-authentication of TUI
using device-code.

Navigate to `Jans TUI` on upper right corner of the screen and hit enter.

![](../../../../assets/image-tui-exit-logout.png)
16 changes: 16 additions & 0 deletions docs/admin/reference/json/feature-flags/README.md
Expand Up @@ -18,6 +18,22 @@ Navigate through the left navigation panel to see the complete list of feature f
An administrator can enable or disable feature flags using [TUI](../../../config-guide/config-tools/jans-tui/README.md). New value
of the feature flag will be dynamically loaded at an interval of 30 seconds.

### Updating Feature Flags Using TUI

![](../../../../assets/image-tui-feature-flags.png)

1. Open TUI as instructed [here](../../../config-guide/config-tools/jans-tui/README.md)
2. Navigate to `Auth Server`->`Properties`
3. In the `Search` box, type `featureflags` and hit enter. Result should show
`featureFlag` property. Hitting enter will open a dialogue box where it is
possible to edit feature flags list
4. Add or Remove the feature flags as needed
5. Select `Save`
6. Wait for 30 seconds and changes should be effective

### Updating Feature Flags Using CLI



!!! Contribute
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation)
Binary file added docs/assets/image-tui-exit-logout.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/image-tui-feature-flags.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7c29339

Please sign in to comment.