Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IKC-444 Documentation for onboarding #431

Open
wants to merge 1 commit into
base: IKC-446
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@


* [Features](FEATURES.md)
* [Onboarding](features/ONBOARDING.md)


* [FAQ](FAQ.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/features/ONBOARDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Onboarding

When you launch Kouncil and no user groups and permissions are defined you will
see popup which will inform you that you will be logged in as temporary user to define them.

<p align="left">
<img src="../.github/img/features/onboarding/onboarding_popup.png" width="820">
</p>

After logging in you will see banner at the top of the page which will have information that you are
logged in as temporary user.

<p align="left">
<img src="../.github/img/features/onboarding/onboarding.png" width="820">
</p>

After saving user groups permissions, temporary user will not be logged out. This will happen only
if you manually click logout button. This is done so you can verify, that you defined groups and
permissions correctly. After manual logout temporary user will be removed. And you will be able
to log in with:
* predefined users (admin, editor, viewer, superuser) in inmemory authentication
* real users for other authentication methods, ldap, ad, sso.

{% hint style="info" %}
**INFO**

For **inmemory** authentication groups and permissions will be preloaded.
{% endhint %}
Loading