mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-23 20:47:01 +01:00
fix(docs): filename, header and title mismatch fixes (#2660)
This commit is contained in:
parent
fcc65e6fbe
commit
4849d9844b
|
@ -1,37 +1,37 @@
|
||||||
# Kanidm
|
# Kanidm
|
||||||
|
|
||||||
- [Introduction to Kanidm](intro.md)
|
- [Introduction to Kanidm](introduction_to_kanidm.md)
|
||||||
|
|
||||||
- [Evaluation Quickstart](quickstart.md)
|
- [Evaluation Quickstart](evaluation_quickstart.md)
|
||||||
|
|
||||||
- [Supported Features](features.md)
|
- [Supported Features](supported_features.md)
|
||||||
- [Project Support](support.md)
|
- [Project Support](support.md)
|
||||||
|
|
||||||
- [Installing the Server](installing_the_server.md)
|
- [Installing the Server](installing_the_server.md)
|
||||||
- [Choosing a Domain Name](choosing_a_domain_name.md)
|
- [Choosing a Domain Name](choosing_a_domain_name.md)
|
||||||
- [Preparing for your Deployment](prepare_the_server.md)
|
- [Preparing for your Deployment](preparing_for_your_deployment.md)
|
||||||
- [Server Configuration and Install](server_configuration.md)
|
- [Server Configuration](server_configuration.md)
|
||||||
- [Platform Security Hardening](security_hardening.md)
|
- [Security Hardening](security_hardening.md)
|
||||||
- [Server Updates](server_update.md)
|
- [Server Updates](server_updates.md)
|
||||||
|
|
||||||
- [Client Tools](client_tools.md)
|
- [Client Tools](client_tools.md)
|
||||||
- [Installing client tools](installing_client_tools.md)
|
- [Installing Client Tools](installing_client_tools.md)
|
||||||
|
|
||||||
- [Administration](administrivia.md)
|
- [Administration](administration.md)
|
||||||
- [Backup and Restore](backup_restore.md)
|
- [Backup and Restore](backup_and_restore.md)
|
||||||
- [Database Maintenance](database_maint.md)
|
- [Database Maintenance](database_maintenance.md)
|
||||||
- [Domain Rename](domain_rename.md)
|
- [Domain Rename](domain_rename.md)
|
||||||
- [Monitoring the platform](monitoring.md)
|
- [Monitoring the platform](monitoring_the_platform.md)
|
||||||
- [The Recycle Bin](recycle_bin.md)
|
- [Recycle Bin](recycle_bin.md)
|
||||||
|
|
||||||
- [Accounts and Groups](accounts/intro.md)
|
- [Accounts and Groups](accounts/intro.md)
|
||||||
- [People Accounts](accounts/people.md)
|
- [People Accounts](accounts/people_accounts.md)
|
||||||
- [Authentication and Credentials](accounts/authentication.md)
|
- [Authentication and Credentials](accounts/authentication_and_credentials.md)
|
||||||
- [Groups](accounts/groups.md)
|
- [Groups](accounts/groups.md)
|
||||||
- [Service Accounts](accounts/service.md)
|
- [Service Accounts](accounts/service_accounts.md)
|
||||||
- [Anonymous](accounts/anonymous.md)
|
- [Anonymous Account](accounts/anonymous_account.md)
|
||||||
- [Account Policy](accounts/policy.md)
|
- [Account Policy](accounts/account_policy.md)
|
||||||
- [POSIX Accounts and Groups](accounts/posix.md)
|
- [POSIX Accounts and Groups](accounts/posix_accounts_and_groups.md)
|
||||||
|
|
||||||
- [Service Integrations](integrations/readme.md)
|
- [Service Integrations](integrations/readme.md)
|
||||||
- [PAM and nsswitch](integrations/pam_and_nsswitch.md)
|
- [PAM and nsswitch](integrations/pam_and_nsswitch.md)
|
||||||
|
@ -39,13 +39,13 @@
|
||||||
- [Fedora](integrations/pam_and_nsswitch/fedora.md)
|
- [Fedora](integrations/pam_and_nsswitch/fedora.md)
|
||||||
- [Troubleshooting](integrations/pam_and_nsswitch/troubleshooting.md)
|
- [Troubleshooting](integrations/pam_and_nsswitch/troubleshooting.md)
|
||||||
- [SSSD](integrations/sssd.md)
|
- [SSSD](integrations/sssd.md)
|
||||||
- [SSH Key Distribution](integrations/ssh_key_dist.md)
|
- [SSH Key Distribution](integrations/ssh_key_distribution.md)
|
||||||
- [Oauth2](integrations/oauth2.md)
|
- [Oauth2](integrations/oauth2.md)
|
||||||
- [LDAP](integrations/ldap.md)
|
- [LDAP](integrations/ldap.md)
|
||||||
- [RADIUS](integrations/radius.md)
|
- [RADIUS](integrations/radius.md)
|
||||||
|
|
||||||
- [Service Integration Examples](examples/readme.md)
|
- [Service Integration Examples](examples/readme.md)
|
||||||
- [Kubernetes Ingress](examples/k8s_ingress_example.md)
|
- [Kubernetes Ingress](examples/kubernetes_ingress.md)
|
||||||
- [Traefik](examples/traefik.md)
|
- [Traefik](examples/traefik.md)
|
||||||
|
|
||||||
- [Replication](repl/readme.md)
|
- [Replication](repl/readme.md)
|
||||||
|
@ -63,28 +63,28 @@
|
||||||
|
|
||||||
- [Troubleshooting](troubleshooting.md)
|
- [Troubleshooting](troubleshooting.md)
|
||||||
- [Frequently Asked Questions](frequently_asked_questions.md)
|
- [Frequently Asked Questions](frequently_asked_questions.md)
|
||||||
- [Glossary of Technical Terms](glossary.md)
|
- [Glossary](glossary.md)
|
||||||
|
|
||||||
# For Developers
|
# For Developers
|
||||||
|
|
||||||
- [Developer Guide](developers/readme.md)
|
- [Developer Guide](developers/readme.md)
|
||||||
- [Developer Ethics](developers/ethics.md)
|
- [Developer Ethics](developers/developer_ethics.md)
|
||||||
- [Frequently Asked Questions](developers/faq.md)
|
- [Frequently Asked Questions](developers/faq.md)
|
||||||
- [Design Documents]()
|
- [Design Documents]()
|
||||||
- [Access Profiles 2022](developers/designs/access_profiles_rework_2022.md)
|
- [Access Profiles 2022](developers/designs/access_profiles_rework_2022.md)
|
||||||
- [Access Profiles Original](developers/designs/access_profiles_and_security.md)
|
- [Access Profiles Original](developers/designs/access_profiles_original.md)
|
||||||
- [Access Control Defaults](developers/designs/access_control_defaults.md)
|
- [Access Control Defaults](developers/designs/access_control_defaults.md)
|
||||||
- [Architecture](developers/designs/architecture.md)
|
- [Architecture](developers/designs/architecture.md)
|
||||||
- [Authentication flow](developers/designs/authentication_flow.md)
|
- [Authentication flow](developers/designs/authentication_flow.md)
|
||||||
- [Cryptography Key Domains (2024)](developers/designs/cryptography-key-domains.md)
|
- [Cryptography Key Domains (2024)](developers/designs/cryptography_key_domains.md)
|
||||||
- [Domain Join](developers/designs/domain_join.md)
|
- [Domain Join - Machine Accounts](developers/designs/domain_join_machine_accounts.md)
|
||||||
- [Elevated Priv Mode](developers/designs/elevated_priv_mode.md)
|
- [Elevated Priv Mode](developers/designs/elevated_priv_mode.md)
|
||||||
- [Oauth2 Refresh Tokens](developers/designs/oauth2_refresh_tokens.md)
|
- [Oauth2 Refresh Tokens](developers/designs/oauth2_refresh_tokens.md)
|
||||||
- [Replication Coordinator](developers/designs/replication_coord.md)
|
- [Replication Coordinator](developers/designs/replication_coordinator.md)
|
||||||
- [Replication Internals](developers/designs/replication.md)
|
- [Replication Design and Notes](developers/designs/replication_design_and_notes.md)
|
||||||
- [REST Interface](developers/designs/rest_interface.md)
|
- [REST Interface](developers/designs/rest_interface.md)
|
||||||
- [Python Module](developers/python.md)
|
- [Python Module](developers/python_module.md)
|
||||||
- [RADIUS Integration](developers/radius.md)
|
- [RADIUS Module Development](developers/radius.md)
|
||||||
- [Release Checklist](developers/release_checklist.md)
|
- [Release Checklist](developers/release_checklist.md)
|
||||||
- [Packaging](developers/packaging.md)
|
- [Packaging](developers/packaging.md)
|
||||||
- [Debian/Ubuntu](developers/packaging_debs.md)
|
- [Debian/Ubuntu](developers/debian_ubuntu_packaging.md)
|
||||||
|
|
|
@ -27,7 +27,7 @@ text=Kanidm's definition of Passkeys may differ from that of other systems. This
|
||||||
### Attested Passkeys
|
### Attested Passkeys
|
||||||
|
|
||||||
These are the same as Passkeys, except that the device must present a cryptographic certificate or
|
These are the same as Passkeys, except that the device must present a cryptographic certificate or
|
||||||
origin during registration. This allows [account policy](policy.md) to be defined to only allow the
|
origin during registration. This allows [account policy](account_policy.md) to be defined to only allow the
|
||||||
use of certain models of authenticator. In general only FIDO2 keys or TPM's are capable of meeting
|
use of certain models of authenticator. In general only FIDO2 keys or TPM's are capable of meeting
|
||||||
attestation requirements.
|
attestation requirements.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Administration Tasks
|
# Administration
|
||||||
|
|
||||||
This chapter describes some of the routine administration tasks for running a Kanidm server, such as
|
This chapter describes some of the routine administration tasks for running a Kanidm server, such as
|
||||||
making backups and restoring from backups, testing server configuration, reindexing, verifying data
|
making backups and restoring from backups, testing server configuration, reindexing, verifying data
|
|
@ -1,4 +1,4 @@
|
||||||
# Client tools
|
# Client Tools
|
||||||
|
|
||||||
To interact with Kanidm as an administrator, you'll need to use our command line tools. If you
|
To interact with Kanidm as an administrator, you'll need to use our command line tools. If you
|
||||||
haven't installed them yet, [install them now](installing_client_tools.md).
|
haven't installed them yet, [install them now](installing_client_tools.md).
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Access Profiles
|
# Access Profiles Original
|
||||||
|
|
||||||
Access Profiles (ACPs) are a way of expressing the set of actions which accounts are permitted to
|
Access Profiles (ACPs) are a way of expressing the set of actions which accounts are permitted to
|
||||||
perform on database records (`object`) in the system.
|
perform on database records (`object`) in the system.
|
|
@ -1,4 +1,4 @@
|
||||||
## Architectural Overview
|
## Architecture
|
||||||
|
|
||||||
Kanidm has a number of components and layers that make it up. As this project is continually
|
Kanidm has a number of components and layers that make it up. As this project is continually
|
||||||
evolving, if you have questions or notice discrepancies with this document please contact William
|
evolving, if you have questions or notice discrepancies with this document please contact William
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# The Authentication Flow
|
# Authentication Flow
|
||||||
|
|
||||||
1. Client sends an init request. This can be either:
|
1. Client sends an init request. This can be either:
|
||||||
1. `AuthStep::Init` which just includes the username, or
|
1. `AuthStep::Init` which just includes the username, or
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Replication Coordinator Design
|
# Replication Coordinator
|
||||||
|
|
||||||
Many other IDM systems configure replication on each node of the topology. This means that the
|
Many other IDM systems configure replication on each node of the topology. This means that the
|
||||||
administrator is responsible for ensuring all nodes are connected properly, and that agreements are
|
administrator is responsible for ensuring all nodes are connected properly, and that agreements are
|
|
@ -1,4 +1,4 @@
|
||||||
# Statement of ethics and rights
|
# Developer Ethics
|
||||||
|
|
||||||
Kanidm is a project that will store, process and present people's personal data. This means we have
|
Kanidm is a project that will store, process and present people's personal data. This means we have
|
||||||
a responsibility to respect the data of all people who could be using our system - many who interact
|
a responsibility to respect the data of all people who could be using our system - many who interact
|
|
@ -1,4 +1,4 @@
|
||||||
# Kanidm Python Module
|
# Python Module
|
||||||
|
|
||||||
So far it includes:
|
So far it includes:
|
||||||
|
|
|
@ -13,7 +13,7 @@ consumers - many of who are unlikely to be in a position to contact us to ask fo
|
||||||
|
|
||||||
### Ethics / Rights
|
### Ethics / Rights
|
||||||
|
|
||||||
If you have not already, please see our documentation on [rights and ethics](ethics.md)
|
If you have not already, please see our documentation on [rights and ethics](developer_ethics.md)
|
||||||
|
|
||||||
### Humans First
|
### Humans First
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Release checklist
|
# Release Checklist
|
||||||
|
|
||||||
## Pre-Reqs
|
## Pre-Reqs
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Rename the domain
|
# Domain Rename
|
||||||
|
|
||||||
There are some cases where you may need to rename the domain. You should have configured this
|
There are some cases where you may need to rename the domain. You should have configured this
|
||||||
initially in the setup, however you may have a situation where a business is changing name, merging,
|
initially in the setup, however you may have a situation where a business is changing name, merging,
|
||||||
|
|
|
@ -102,4 +102,4 @@ Then follow the presented steps.
|
||||||
|
|
||||||
### What next?
|
### What next?
|
||||||
|
|
||||||
You can now follow the steps in the [administration section](administrivia.md)
|
You can now follow the steps in the [administration section](administration.md)
|
|
@ -1,4 +1,4 @@
|
||||||
# Configuring the Server
|
# Server Configuration
|
||||||
|
|
||||||
In this section we will configure your server and create its container instance.
|
In this section we will configure your server and create its container instance.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Updating the Server
|
# Server Updates
|
||||||
|
|
||||||
## General Update Notes
|
## General Update Notes
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Synchronising from FreeIPA
|
# FreeIPA
|
||||||
|
|
||||||
FreeIPA is a popular opensource LDAP and Kerberos provider, aiming to be "Active Directory" for
|
FreeIPA is a popular opensource LDAP and Kerberos provider, aiming to be "Active Directory" for
|
||||||
Linux.
|
Linux.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Synchronising from LDAP
|
# LDAP
|
||||||
|
|
||||||
If you have an LDAP server that supports sync repl (rfc4533 content synchronisation) then you are
|
If you have an LDAP server that supports sync repl (rfc4533 content synchronisation) then you are
|
||||||
able to synchronise from it to Kanidm for the purposes of coexistence or migration.
|
able to synchronise from it to Kanidm for the purposes of coexistence or migration.
|
||||||
|
|
Loading…
Reference in a new issue