diff --git a/docs/images/brand.svg b/docs/images/brand.svg new file mode 100644 index 000000000..15c3f9d61 --- /dev/null +++ b/docs/images/brand.svg @@ -0,0 +1,2 @@ + diff --git a/docs/images/brand_inverted.svg b/docs/images/brand_inverted.svg new file mode 100644 index 000000000..86711c6bb --- /dev/null +++ b/docs/images/brand_inverted.svg @@ -0,0 +1,2 @@ + diff --git a/.github/screen_admin.png b/docs/images/screen_admin.png similarity index 100% rename from .github/screen_admin.png rename to docs/images/screen_admin.png diff --git a/.github/screen_apps.png b/docs/images/screen_apps.png similarity index 100% rename from .github/screen_apps.png rename to docs/images/screen_apps.png diff --git a/docs/index.md b/docs/index.md index 309acb089..954916e1d 100755 --- a/docs/index.md +++ b/docs/index.md @@ -1,31 +1,16 @@ -# Welcome +# +![passbook logo](images/logo.svg){: style="height:50px"} +![passbook brand](images/brand.svg){: style="height:50px"} -Welcome to the passbook Documentation. passbook is an open-source Identity Provider and Usermanagement software. It can be used as a central directory for users or customers and it can integrate with your existing Directory. +## What is passbook? -passbook can also be used as part of an Application to facilitate User Enrollment, Password recovery and Social Login. +passbook is an open-source Identity Provider focused on flexibility and versatility. You can use passbook in an existing environment to add support for new protocols. passbook is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it. -passbook uses the following Terminology: +## Installation -### Policy +See [Docker-compose](installation/docker-compose.md) or [Kubernetes](installation/kubernetes.md) -A Policy is at a base level a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the User is member of the specified Group and False if not. This can be used to conditionally apply Factors and grant/deny access. +## Screenshots -### Provider - -A Provider is a way for other Applications to authenticate against passbook. Common Providers are OpenID Connect (OIDC) and SAML. - -### Source - -Sources are ways to get users into passbook. This might be an LDAP Connection to import Users from Active Directory, or an OAuth2 Connection to allow Social Logins. - -### Application - -An application links together Policies with a Provider, allowing you to control access. It also holds Information like UI Name, Icon and more. - -### Factors - -Factors represent Authentication Factors, like a Password or OTP. These Factors can be dynamically enabled using policies. This allows you to, for example, force users from a certain IP ranges to complete a Captcha to authenticate. - -### Property Mappings - -Property Mappings allow you to make Information available for external Applications. For example, if you want to login to AWS with passbook, you'd use Property Mappings to set the User's Roles based on their Groups. +![](images/screen_apps.png) +![](images/screen_admin.png) diff --git a/docs/policies/index.md b/docs/policies/index.md index 362f43d54..4c86878b2 100644 --- a/docs/policies/index.md +++ b/docs/policies/index.md @@ -27,11 +27,11 @@ See [Expression Policy](expression.md). This Policy allows you to specify Password rules, like Length and required Characters. The following rules can be set: -- Minimum amount of Uppercase Characters -- Minimum amount of Lowercase Characters -- Minimum amount of Symbols Characters -- Minimum Length -- Symbol charset (define which characters are counted as symbols) +- Minimum amount of Uppercase Characters +- Minimum amount of Lowercase Characters +- Minimum amount of Symbols Characters +- Minimum Length +- Symbol charset (define which characters are counted as symbols) ### Have I Been Pwned Policy diff --git a/docs/terminology.md b/docs/terminology.md new file mode 100644 index 000000000..1b345e079 --- /dev/null +++ b/docs/terminology.md @@ -0,0 +1,27 @@ +### Policy + +A Policy is at a base level a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the User is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects and is also used for other custom logic. + +### Provider + +A Provider is a way for other Applications to authenticate against passbook. Common Providers are OpenID Connect (OIDC) and SAML. + +### Source + +Sources are ways to get users into passbook. This might be an LDAP Connection to import Users from Active Directory, or an OAuth2 Connection to allow Social Logins. + +### Application + +An application links together Policies with a Provider, allowing you to control access. It also holds Information like UI Name, Icon and more. + +### Flows + +Flows are a method of describing a sequence of stages. These flows can be used to defined how a user authenticates, enrolls, etc. + +### Stages + +A stage represents a single verification or logic step. They are used to authenticate users, enroll them, and more. These stages can optionally be applied to a flow via policies. + +### Property Mappings + +Property Mappings allow you to make Information available for external Applications. For example, if you want to login to AWS with passbook, you'd use Property Mappings to set the User's Roles based on their Groups.