-
Notifications
You must be signed in to change notification settings - Fork 191
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
Overhaul identity docs #2814
Overhaul identity docs #2814
Changes from all commits
be2c813
e5a0567
8e01d85
4ce98fd
9727f1c
bad8f04
02155f0
51c6cc4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,20 @@ | ||
--- | ||
id: install-identity | ||
title: "Installation and first steps" | ||
sidebar_label: "Installation and first steps" | ||
description: "Learn more about installing Identity, accessing the UI, default users, the home screen, and more." | ||
title: "First steps" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is only an introduction to initial configuration and UIs after logging in with demo demo. All installation instructions were moved. |
||
sidebar_label: "First steps" | ||
description: "Learn more about accessing the Identity UI, default users, the home screen, and more." | ||
--- | ||
|
||
To use Identity, install it locally via Docker or Kubernetes. | ||
Before you can work with Identity, you need to install it along with other Camunda 8 components. | ||
|
||
Follow the [installation guide](/self-managed/platform-deployment/overview.md) for more details on this process. | ||
|
||
## Accessing the UI | ||
|
||
As soon as Identity is started, you can access the login page and log in to the Identity application. | ||
|
||
<!-- Let's move away from recommending localhost first. What port or URL would they find Identity if they used Helm Kubernetes? --> | ||
|
||
Navigate to [localhost:8080](http://localhost:8080) to see the UI exposed by Identity. | ||
|
||
![identity-login-page](./img/identity-login-page.png) | ||
|
@@ -21,6 +23,9 @@ Navigate to [localhost:8080](http://localhost:8080) to see the UI exposed by Ide | |
|
||
The configuration in this guide creates an example user during installation; use this account to log in: | ||
|
||
<!-- Is this true for any setup? --> | ||
<!-- For setting up production systems, we should nudge users to remove this configuration prior to launching. --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to add removing the demo user from https://docs.camunda.io/docs/self-managed/identity/user-guide/configuration/making-identity-production-ready/? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The demo user is included in the helm charts (it seems that this is the default case). Therefore it would make sense to also have it documented in the helm installation part of the docs. What do you think? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Interesting - we should surely mention that the demo/demo user is created by default in the Helm chart. Do we need this page, then? Could we consolidate it with the "What is Identity" page and walk through what screens are available in the Identity UI? |
||
|
||
```text | ||
Username: demo | ||
Password: demo | ||
|
@@ -35,4 +40,8 @@ Creating a user in Identity is not currently supported. To create a user, see | |
|
||
You are directed to the home page once logged in successfully. | ||
|
||
<!-- What should they expect to see on this page? A list of all their applications, including the Identity application? --> | ||
|
||
<!-- This should be the name associated with demo demo or aligned with other screenshot users. --> | ||
|
||
![identity-landing-page](./img/identity-landing-page.png) |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,11 +5,7 @@ sidebar_label: "Incorporate applications" | |
description: "Use Identity to create an application and assign a permission to an application." | ||
--- | ||
|
||
In this guide we will show you how to use Identity to create an application and assign a permission to an application. | ||
|
||
:::tip Want to learn more about applications? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I removed this and used an in-line link in the sentence above since we have a caution admonition right below it. |
||
Head over to our documentation on [applications](/self-managed/concepts/access-control/applications.md) to find out more. | ||
::: | ||
In this guide we will show you how to use Identity to create an [applications](/self-managed/concepts/access-control/applications.md) and assign a permission to an application. | ||
|
||
:::caution Write access needed | ||
To add an application and assign a permission to an application, you need to have write access to Identity. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good opportunity to link to both Tasklist and service worker documentation in the case users aren't familiar.