mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-23 12:37:00 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(docs): typos, grammar and broken link fixes (#2644)

Browse source 
Co-authored-by: Firstyear <william@blackhats.net.au>
This commit is contained in:
José Fortún 2024-03-12 04:38:43 +01:00 committed by GitHub
parent 45f26888be
commit eec7b3fa05
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 25 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -14,7 +14,7 @@ of requirements and integrations. You should not need any other components (like
use Kanidm - we already have everything you need! use Kanidm - we already have everything you need!
To achieve this we rely heavily on strict defaults, simple configuration, and self-healing To achieve this we rely heavily on strict defaults, simple configuration, and self-healing
components. This allows Kanidm to run from small home labs, families, small business, and all the components. This allows Kanidm to run from small home labs, families, small businesses, and all the
way to the largest enterprise needs. way to the largest enterprise needs.
If you want to host your own authentication service, then Kanidm is for you! If you want to host your own authentication service, then Kanidm is for you!
@ -23,16 +23,16 @@ If you want to host your own authentication service, then Kanidm is for you!
Kanidm supports: Kanidm supports:
- Passkeys (webauthn) for secure cryptographic authentication - Passkeys (WebAuthn) for secure cryptographic authentication
- Attested Passkeys for high security environments - Attested passkeys for high security environments
- Oauth2/OIDC Authentication provider for web SSO - OAuth2/OIDC authentication provider for web SSO
- Application Portal allowing easy access to linked applications - Application Portal allowing easy access to linked applications
- Linux/Unix integration with TPM secured offline authentication - Linux/Unix integration with TPM secured offline authentication
- SSH key distribution to Linux/Unix systems - SSH key distribution to Linux/Unix systems
- RADIUS for network and VPN authentication - RADIUS for network and VPN authentication
- Read only LDAPS gateway for Legacy Systems - Read-only LDAPs gateway for Legacy Systems
- Complete CLI tooling for Administration - Complete CLI tooling for Administration
- A WebUI for User Self Service - A WebUI for user self-service
- Two node high availability using database replication - Two node high availability using database replication
</details> </details>
@ -41,33 +41,35 @@ Kanidm supports:
If you want to read more about what Kanidm can do, you should read our documentation. If you want to read more about what Kanidm can do, you should read our documentation.
- [Kanidm book (Latest stable)](https://kanidm.github.io/kanidm/stable/) - [Kanidm book (latest stable)](https://kanidm.github.io/kanidm/stable/)
We also have a set of We also have a set of
[support guidelines](https://github.com/kanidm/kanidm/blob/master/book/src/support.md) for what the [support guidelines](https://github.com/kanidm/kanidm/blob/master/book/src/support.md) for what the
project team will support project team will support.
## Code of Conduct / Ethics ## Code of Conduct / Ethics
All interactions with the project are covered by our [code of conduct]. All interactions with the project are covered by our [code of conduct].
When we develop features we follow our projects guidelines on [rights and ethics] When we develop features, we follow our project's guidelines on [rights and ethics].
[code of conduct]: https://github.com/kanidm/kanidm/blob/master/CODE_OF_CONDUCT.md [code of conduct]: https://github.com/kanidm/kanidm/blob/master/CODE_OF_CONDUCT.md
[rights and ethics]: https://github.com/kanidm/kanidm/blob/master/book/src/developers/ethics.md [rights and ethics]: https://github.com/kanidm/kanidm/blob/master/book/src/developers/ethics.md
## Getting in Contact / Questions ## Getting in Contact / Questions
We have a Matrix-powered [gitter community channel] where project members are always happy to chat We have a Matrix-powered [gitter community channel] where project members are always happy to chat
and answer questions. Alternately you can open a new [github discussion]. and answer questions. Alternately you can open a new [GitHub discussion].
[gitter community channel]: https://app.gitter.im/#/room/#kanidm_community:gitter.im [gitter community channel]: https://app.gitter.im/#/room/#kanidm_community:gitter.im
[github discussion]: https://github.com/kanidm/kanidm/discussions [github discussion]: https://github.com/kanidm/kanidm/discussions
## What does Kanidm mean? ## What does Kanidm mean?
Kanidm is a portmanteau of 'kani' and 'idm'. Kani is Japanese for crab, related to Rust's mascot Kanidm is a portmanteau of 'kani' and 'idm'. Kani is Japanese for crab, related to Rust's mascot
ferris the crab. Identity management is often abbreviated to 'idm', and is a common industry term Ferris the crab. Identity management is often abbreviated to 'idm', and is a common industry term
for authentication providers. for authentication providers.
Kanidm is pronounced as "kar - nee - dee - em". Kanidm is pronounced as "kar - nee - dee - em".
@ -79,8 +81,8 @@ Kanidm is pronounced as "kar - nee - dee - em".
administer LDAP server with a web administration portal. Both projects use the administer LDAP server with a web administration portal. Both projects use the
[Kanidm LDAP bindings](https://github.com/kanidm/ldap3), and have many similar ideas. [Kanidm LDAP bindings](https://github.com/kanidm/ldap3), and have many similar ideas.
The primary benefit of Kanidm over LLDAP is that Kanidm offers a broader set of "built in" features The primary benefit of Kanidm over LLDAP is that Kanidm offers a broader set of "built-in" features
like Oauth2 and OIDC. To use these from LLDAP you need an external portal like Keycloak. However like OAuth2 and OIDC. To use these from LLDAP you need an external portal like Keycloak. However,
that is also a strength of LLDAP is that is offers "less" which may make it easier to administer and that is also a strength of LLDAP is that is offers "less" which may make it easier to administer and
deploy for you. deploy for you.
@ -94,7 +96,7 @@ want a project which has a broader feature set out of the box, then Kanidm will
<details><summary>389-ds / OpenLDAP</summary> <details><summary>389-ds / OpenLDAP</summary>
Both 389-ds and OpenLDAP are generic LDAP servers. This means they only provide LDAP and you need to Both 389-ds and OpenLDAP are generic LDAP servers. This means they only provide LDAP and you need to
bring your own IDM components - you need your own OIDC portal, webui's for self service, commandline bring your own IDM components - you need your own OIDC portal, a WebUI for self-service, commandline
tools to administer and more. tools to administer and more.
If you need the highest levels of customisation possible from your LDAP deployment, then these are If you need the highest levels of customisation possible from your LDAP deployment, then these are
@ -123,15 +125,15 @@ differ however, but generally Kanidm is much faster than FreeIPA).
</details> </details>
<details><summary>Keycloak</summary> <details><summary>Keycloak</summary>
Keycloak is an OIDC/Oauth2/SAML provider. It allows you to layer on Webauthn to existing IDM systems. Keycloak is an OIDC/OAuth2/SAML provider. It allows you to layer on WebAuthn to existing IDM systems.
Keycloak can operate as a stand alone IDM but generally is a component attached to an existing LDAP Keycloak can operate as a stand-alone IDM but generally is a component attached to an existing LDAP
server or similar. server or similar.
Keycloak requires a significant amount of configuration and experience to deploy. It allows high Keycloak requires a significant amount of configuration and experience to deploy. It allows high
levels of customisation to every detail of it's authentication work flows, which makes it harder to levels of customisation to every detail of its authentication work flows, which makes it harder to
start with in many cases. start with in many cases.
Kanidm does NOT require Keycloak to provide services such as Oauth2 and integrates many of the Kanidm does NOT require Keycloak to provide services such as OAuth2 and integrates many of the
elements in a simpler and correct way out of the box in comparison. elements in a simpler and correct way out of the box in comparison.
</details> </details>
@ -144,6 +146,6 @@ backgrounds.
When developing the server you should refer to the latest commit documentation instead. When developing the server you should refer to the latest commit documentation instead.
- [Kanidm book (Latest commit)](https://kanidm.github.io/kanidm/master/) - [Kanidm book (latest commit)](https://kanidm.github.io/kanidm/master/)
[guide for developers]: https://kanidm.github.io/kanidm/stable/developers/readme.html [guide for developers]: https://kanidm.github.io/kanidm/stable/DEVELOPER_README.html