diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index b37570068..d4dca6f43 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -1,37 +1,37 @@ # 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) - [Installing the Server](installing_the_server.md) - [Choosing a Domain Name](choosing_a_domain_name.md) - - [Preparing for your Deployment](prepare_the_server.md) - - [Server Configuration and Install](server_configuration.md) - - [Platform Security Hardening](security_hardening.md) - - [Server Updates](server_update.md) + - [Preparing for your Deployment](preparing_for_your_deployment.md) + - [Server Configuration](server_configuration.md) + - [Security Hardening](security_hardening.md) + - [Server Updates](server_updates.md) - [Client Tools](client_tools.md) - - [Installing client tools](installing_client_tools.md) + - [Installing Client Tools](installing_client_tools.md) -- [Administration](administrivia.md) - - [Backup and Restore](backup_restore.md) - - [Database Maintenance](database_maint.md) +- [Administration](administration.md) + - [Backup and Restore](backup_and_restore.md) + - [Database Maintenance](database_maintenance.md) - [Domain Rename](domain_rename.md) - - [Monitoring the platform](monitoring.md) - - [The Recycle Bin](recycle_bin.md) + - [Monitoring the platform](monitoring_the_platform.md) + - [Recycle Bin](recycle_bin.md) - [Accounts and Groups](accounts/intro.md) - - [People Accounts](accounts/people.md) - - [Authentication and Credentials](accounts/authentication.md) + - [People Accounts](accounts/people_accounts.md) + - [Authentication and Credentials](accounts/authentication_and_credentials.md) - [Groups](accounts/groups.md) - - [Service Accounts](accounts/service.md) - - [Anonymous](accounts/anonymous.md) - - [Account Policy](accounts/policy.md) - - [POSIX Accounts and Groups](accounts/posix.md) + - [Service Accounts](accounts/service_accounts.md) + - [Anonymous Account](accounts/anonymous_account.md) + - [Account Policy](accounts/account_policy.md) + - [POSIX Accounts and Groups](accounts/posix_accounts_and_groups.md) - [Service Integrations](integrations/readme.md) - [PAM and nsswitch](integrations/pam_and_nsswitch.md) @@ -39,13 +39,13 @@ - [Fedora](integrations/pam_and_nsswitch/fedora.md) - [Troubleshooting](integrations/pam_and_nsswitch/troubleshooting.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) - [LDAP](integrations/ldap.md) - [RADIUS](integrations/radius.md) - [Service Integration Examples](examples/readme.md) - - [Kubernetes Ingress](examples/k8s_ingress_example.md) + - [Kubernetes Ingress](examples/kubernetes_ingress.md) - [Traefik](examples/traefik.md) - [Replication](repl/readme.md) @@ -63,28 +63,28 @@ - [Troubleshooting](troubleshooting.md) - [Frequently Asked Questions](frequently_asked_questions.md) -- [Glossary of Technical Terms](glossary.md) +- [Glossary](glossary.md) # For Developers - [Developer Guide](developers/readme.md) -- [Developer Ethics](developers/ethics.md) +- [Developer Ethics](developers/developer_ethics.md) - [Frequently Asked Questions](developers/faq.md) - [Design Documents]() - [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) - [Architecture](developers/designs/architecture.md) - [Authentication flow](developers/designs/authentication_flow.md) - - [Cryptography Key Domains (2024)](developers/designs/cryptography-key-domains.md) - - [Domain Join](developers/designs/domain_join.md) + - [Cryptography Key Domains (2024)](developers/designs/cryptography_key_domains.md) + - [Domain Join - Machine Accounts](developers/designs/domain_join_machine_accounts.md) - [Elevated Priv Mode](developers/designs/elevated_priv_mode.md) - [Oauth2 Refresh Tokens](developers/designs/oauth2_refresh_tokens.md) - - [Replication Coordinator](developers/designs/replication_coord.md) - - [Replication Internals](developers/designs/replication.md) + - [Replication Coordinator](developers/designs/replication_coordinator.md) + - [Replication Design and Notes](developers/designs/replication_design_and_notes.md) - [REST Interface](developers/designs/rest_interface.md) -- [Python Module](developers/python.md) -- [RADIUS Integration](developers/radius.md) +- [Python Module](developers/python_module.md) +- [RADIUS Module Development](developers/radius.md) - [Release Checklist](developers/release_checklist.md) - [Packaging](developers/packaging.md) - - [Debian/Ubuntu](developers/packaging_debs.md) + - [Debian/Ubuntu](developers/debian_ubuntu_packaging.md) diff --git a/book/src/accounts/policy.md b/book/src/accounts/account_policy.md similarity index 100% rename from book/src/accounts/policy.md rename to book/src/accounts/account_policy.md diff --git a/book/src/accounts/anonymous.md b/book/src/accounts/anonymous_account.md similarity index 100% rename from book/src/accounts/anonymous.md rename to book/src/accounts/anonymous_account.md diff --git a/book/src/accounts/authentication.md b/book/src/accounts/authentication_and_credentials.md similarity index 98% rename from book/src/accounts/authentication.md rename to book/src/accounts/authentication_and_credentials.md index b30f72b94..c201baa48 100644 --- a/book/src/accounts/authentication.md +++ b/book/src/accounts/authentication_and_credentials.md @@ -27,7 +27,7 @@ text=Kanidm's definition of Passkeys may differ from that of other systems. This ### Attested Passkeys 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 attestation requirements. diff --git a/book/src/accounts/people.md b/book/src/accounts/people_accounts.md similarity index 100% rename from book/src/accounts/people.md rename to book/src/accounts/people_accounts.md diff --git a/book/src/accounts/posix.md b/book/src/accounts/posix_accounts_and_groups.md similarity index 100% rename from book/src/accounts/posix.md rename to book/src/accounts/posix_accounts_and_groups.md diff --git a/book/src/accounts/service.md b/book/src/accounts/service_accounts.md similarity index 100% rename from book/src/accounts/service.md rename to book/src/accounts/service_accounts.md diff --git a/book/src/administrivia.md b/book/src/administration.md similarity index 91% rename from book/src/administrivia.md rename to book/src/administration.md index 7633528b7..4f85735c1 100644 --- a/book/src/administrivia.md +++ b/book/src/administration.md @@ -1,4 +1,4 @@ -# Administration Tasks +# Administration 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 diff --git a/book/src/backup_restore.md b/book/src/backup_and_restore.md similarity index 100% rename from book/src/backup_restore.md rename to book/src/backup_and_restore.md diff --git a/book/src/client_tools.md b/book/src/client_tools.md index a71c09370..9c87c5a8c 100644 --- a/book/src/client_tools.md +++ b/book/src/client_tools.md @@ -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 haven't installed them yet, [install them now](installing_client_tools.md). diff --git a/book/src/database_maint.md b/book/src/database_maintenance.md similarity index 100% rename from book/src/database_maint.md rename to book/src/database_maintenance.md diff --git a/book/src/developers/packaging_debs.md b/book/src/developers/debian_ubuntu_packaging.md similarity index 100% rename from book/src/developers/packaging_debs.md rename to book/src/developers/debian_ubuntu_packaging.md diff --git a/book/src/developers/designs/access_profiles_and_security.md b/book/src/developers/designs/access_profiles_original.md similarity index 99% rename from book/src/developers/designs/access_profiles_and_security.md rename to book/src/developers/designs/access_profiles_original.md index 648f80fcd..445cda73d 100644 --- a/book/src/developers/designs/access_profiles_and_security.md +++ b/book/src/developers/designs/access_profiles_original.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 perform on database records (`object`) in the system. diff --git a/book/src/developers/designs/architecture.md b/book/src/developers/designs/architecture.md index fed3c17b2..37b215931 100644 --- a/book/src/developers/designs/architecture.md +++ b/book/src/developers/designs/architecture.md @@ -1,4 +1,4 @@ -## Architectural Overview +## Architecture 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 diff --git a/book/src/developers/designs/authentication_flow.md b/book/src/developers/designs/authentication_flow.md index 5ac6c59e5..1aea69617 100644 --- a/book/src/developers/designs/authentication_flow.md +++ b/book/src/developers/designs/authentication_flow.md @@ -1,4 +1,4 @@ -# The Authentication Flow +# Authentication Flow 1. Client sends an init request. This can be either: 1. `AuthStep::Init` which just includes the username, or diff --git a/book/src/developers/designs/cryptography-key-domains.md b/book/src/developers/designs/cryptography_key_domains.md similarity index 100% rename from book/src/developers/designs/cryptography-key-domains.md rename to book/src/developers/designs/cryptography_key_domains.md diff --git a/book/src/developers/designs/domain_join.md b/book/src/developers/designs/domain_join_machine_accounts.md similarity index 100% rename from book/src/developers/designs/domain_join.md rename to book/src/developers/designs/domain_join_machine_accounts.md diff --git a/book/src/developers/designs/replication_coord.md b/book/src/developers/designs/replication_coordinator.md similarity index 99% rename from book/src/developers/designs/replication_coord.md rename to book/src/developers/designs/replication_coordinator.md index 015f83764..d01f131d0 100644 --- a/book/src/developers/designs/replication_coord.md +++ b/book/src/developers/designs/replication_coordinator.md @@ -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 administrator is responsible for ensuring all nodes are connected properly, and that agreements are diff --git a/book/src/developers/designs/replication.md b/book/src/developers/designs/replication_design_and_notes.md similarity index 100% rename from book/src/developers/designs/replication.md rename to book/src/developers/designs/replication_design_and_notes.md diff --git a/book/src/developers/ethics.md b/book/src/developers/developer_ethics.md similarity index 98% rename from book/src/developers/ethics.md rename to book/src/developers/developer_ethics.md index 89726af8a..8dfac8711 100644 --- a/book/src/developers/ethics.md +++ b/book/src/developers/developer_ethics.md @@ -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 a responsibility to respect the data of all people who could be using our system - many who interact diff --git a/book/src/developers/python.md b/book/src/developers/python_module.md similarity index 98% rename from book/src/developers/python.md rename to book/src/developers/python_module.md index 2f5424e7f..0aa8d5861 100644 --- a/book/src/developers/python.md +++ b/book/src/developers/python_module.md @@ -1,4 +1,4 @@ -# Kanidm Python Module +# Python Module So far it includes: diff --git a/book/src/developers/radius.md b/book/src/developers/radius_module_development.md similarity index 100% rename from book/src/developers/radius.md rename to book/src/developers/radius_module_development.md diff --git a/book/src/developers/readme.md b/book/src/developers/readme.md index 82442b2c5..42810f9f1 100644 --- a/book/src/developers/readme.md +++ b/book/src/developers/readme.md @@ -13,7 +13,7 @@ consumers - many of who are unlikely to be in a position to contact us to ask fo ### 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 diff --git a/book/src/developers/release_checklist.md b/book/src/developers/release_checklist.md index 1ad59f01c..32d924328 100644 --- a/book/src/developers/release_checklist.md +++ b/book/src/developers/release_checklist.md @@ -1,4 +1,4 @@ -# Release checklist +# Release Checklist ## Pre-Reqs diff --git a/book/src/domain_rename.md b/book/src/domain_rename.md index faec9c55d..e82a5c1c8 100644 --- a/book/src/domain_rename.md +++ b/book/src/domain_rename.md @@ -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 initially in the setup, however you may have a situation where a business is changing name, merging, diff --git a/book/src/quickstart.md b/book/src/evaluation_quickstart.md similarity index 99% rename from book/src/quickstart.md rename to book/src/evaluation_quickstart.md index f0c932d73..79f376bb0 100644 --- a/book/src/quickstart.md +++ b/book/src/evaluation_quickstart.md @@ -102,4 +102,4 @@ Then follow the presented steps. ### 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) diff --git a/book/src/examples/k8s_ingress_example.md b/book/src/examples/kubernetes_ingress.md similarity index 100% rename from book/src/examples/k8s_ingress_example.md rename to book/src/examples/kubernetes_ingress.md diff --git a/book/src/integrations/ssh_key_dist.md b/book/src/integrations/ssh_key_distribution.md similarity index 100% rename from book/src/integrations/ssh_key_dist.md rename to book/src/integrations/ssh_key_distribution.md diff --git a/book/src/intro.md b/book/src/introduction_to_kanidm.md similarity index 100% rename from book/src/intro.md rename to book/src/introduction_to_kanidm.md diff --git a/book/src/monitoring.md b/book/src/monitoring_the_platform.md similarity index 100% rename from book/src/monitoring.md rename to book/src/monitoring_the_platform.md diff --git a/book/src/prepare_the_server.md b/book/src/preparing_for_your_deployment.md similarity index 100% rename from book/src/prepare_the_server.md rename to book/src/preparing_for_your_deployment.md diff --git a/book/src/server_configuration.md b/book/src/server_configuration.md index 745fc5c1f..63ec0857a 100644 --- a/book/src/server_configuration.md +++ b/book/src/server_configuration.md @@ -1,4 +1,4 @@ -# Configuring the Server +# Server Configuration In this section we will configure your server and create its container instance. diff --git a/book/src/server_update.md b/book/src/server_updates.md similarity index 99% rename from book/src/server_update.md rename to book/src/server_updates.md index 22bf8ba2e..902ffafd7 100644 --- a/book/src/server_update.md +++ b/book/src/server_updates.md @@ -1,4 +1,4 @@ -# Updating the Server +# Server Updates ## General Update Notes diff --git a/book/src/features.md b/book/src/supported_features.md similarity index 100% rename from book/src/features.md rename to book/src/supported_features.md diff --git a/book/src/sync/freeipa.md b/book/src/sync/freeipa.md index 541fb0743..4da11cbe9 100644 --- a/book/src/sync/freeipa.md +++ b/book/src/sync/freeipa.md @@ -1,4 +1,4 @@ -# Synchronising from FreeIPA +# FreeIPA FreeIPA is a popular opensource LDAP and Kerberos provider, aiming to be "Active Directory" for Linux. diff --git a/book/src/sync/ldap.md b/book/src/sync/ldap.md index d0bc3671c..d1e046d72 100644 --- a/book/src/sync/ldap.md +++ b/book/src/sync/ldap.md @@ -1,4 +1,4 @@ -# Synchronising from LDAP +# LDAP 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.