Skip to content

Commit

Permalink
Adjust idm docs after it's now running by default
Browse files Browse the repository at this point in the history
  • Loading branch information
rhafer committed Apr 27, 2022
1 parent f245ee3 commit 5da1d64
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/extensions/idm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ geekdocCollapseSection: true

## Abstract

The IDM service provides a minimal LDAP Service (based on https://github.com/libregraph/idm) for oCIS. It is started as part of
the default configuration and serves as a central place for storing user and group informationn.

It is mainly targeted at small oCIS installations. For larger setups it is recommended to replace IDM with a "real" LDAP server
or to switch to an external Identity Management Solution.

IDM listens on port 9325 by default. In the default configuration it only accepts TLS protected connections (LDAPS). The BaseDN
of the LDAP tree is `o=libregraph-idm`. IDM gives LDAP write permissions to a single user
(DN: `uid=libregraph,ou=sysusers,o=libregraph-idm`) any other authenticated user has read-only access.

Note: IDM is limited in its functionality. It only supports a subset of the LDAP operations (namely BIND, SEARCH, ADD, MODIFY, DELETE).
Also IDM currently does not do any Schema Verification (e.g. structural vs. auxillary Objectclasses, require and option Attributes,
Syntax Checks, ...). So it's not meant as a general purpose LDAP server.

## Table of Contents

Expand Down
2 changes: 1 addition & 1 deletion docs/ocis/getting-started/demo-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ oCIS has the option to create demo users during the first startup. These enable

{{< hint info >}}
To create the demo users, run the initial setup step with an additional environment variable.
`ACCOUNTS_DEMO_USERS_AND_GROUPS=true ./bin/ocis server` will generate the demo users listed in the table below. By default, it only generates the admin and one user for IDP and Reva respectively.
`IDM_CREATE_DEMO_USERS=true ./bin/ocis server` will generate the demo users listed in the table below. By default, it only generates the admin and one user for IDP and Reva respectively.
{{< /hint >}}

Following users are available in the demo set:
Expand Down

0 comments on commit 5da1d64

Please sign in to comment.