Documentation

User Documentation

• Quick Start Guide

• Deployment Recommendations

• Troubleshooting Guide: how to debug the most common problems, how to report bugs

• HOW TOs: working with FreeIPA, interoperability with other systems, 3rd party Applications Integration

• Frequently Asked Questions

User Guides

Use Red Hat Enteprise Linux documentation:

• FreeIPA 3.0.x:

  • Identity Management Guide for RHEL 6 (report bug)

• FreeIPA 3.3.x and 4.x:

  • RHEL 8: Identity Management documentation

  • RHEL 9: Identity Management documentation

  • Linux Domain Identity, Authentication and Policy Guide for RHEL 7 (report bug)

  • Windows Integration Guide for RHEL 7 (report bug)

  • System-Level Authentication Guide for RHEL 7 (report bug)

Upstream user guide is not maintained anymore as all effort is put into the Red Hat Enteprise Linux documentation. Bugs found in the documentation can be reported in Red Hat Issues tracker by choosing RHELDOCS project and Documentation component.

By Component

Learn about FreeIPA by reading information about the particular components that compose the entire solution.

• Directory Server

• Kerberos

• PKI

• DNS

• Certmonger

• NTP Server

• Web UI

• Trusts

• Client

Additional Resources

• FreeIPA Planet: blog/RSS aggregator

Old Resources

• FreeIPA 1.2.1 and FreeIPA 2.0.0 deprecated user guides

• Old FreeIPA v1.2.1 Documentation Page

Developer Documentation

Design goals and core decisions

• Active Directory integration

• Scalability

• ACIs

Feature Designs

This section contains designs that have actually been implemented in FreeIPA:

• Version 4 Designs, Version 4 Minor Enhancements

• Version 3 Designs, Version 3 Minor Enhancements

• Version 2 Designs

• Version 1 Designs

Feature Proposals

This section contains new or historical proposal that have not yet been approved/implemented or that have been superseded or abandoned.

• Version 4 Proposals

• Version 3 Proposals

• Version 2 Proposals

• Version 1 Proposals

Additional Resources

• Tour of FreeIPA 389-ds plugins

• Extending FreeIPA Guide

• How to add a new attribute to IPA

• How to migrate your code to the new LDAP API

• v2 PRD: draft requirements for FreeIPA v2

• FreeIPA v2 Development Progress: Portal to v2 design pages and current code repositories.

• Federated Authentication Utilizing Apache & SSSD

Tester Documentation

Test Plans

This section contains test plans that have been designed for FreeIPA:

• Version 4 Test Plans

FreeIPA Training Series

FreeIPA 4.5

• FreeIPA CA

• Introduction to LDAP

FreeIPA 3.3 & SSSD 1.11

FreeIPA server presentations

• FreeIPA 3.3 Trust features

• Blending FreeIPA in a Certificate Infrastructure

• Extending the FreeIPA Server

• AD Trust for Legacy Clients

• FreeIPA Client and Server Improvements in 3.3

SSSD client presentations

• SSSD Active Directory Improvements in 1.11

• SSSD AD Provider: Access Control

• SSSD DNS Improvements in AD Environment

FreeIPA 3.0 & SSSD 1.9.2

FreeIPA server presentations

• FreeIPA Trust Basics (ODP)

• FreeIPA Server/Client Core Changes (ODP)

• SSH Public Keys Feature (ODP)

• SELinux User Maps Feature (ODP)

• DNS Persistent Search Feature (ODP)

• DNS Zone Transfers (ODP)

SSSD client presentations

• SSSD AD Provider Feature (ODP)

• SSSD AutoFS Integration (ODP)

• SSSD OpenSSH Integration (ODP)

• SSSD Pre-Seeding Users for First Boot (ODP)

• SSSD SUDO Integration Feature (ODP)

Public Presentations

Here you can find presentations or other materials which FreeIPA team presented on various public conferences.

• Devconf 2018: Smart Card in Identity Management (talk on youtube)

• SnowCamp.io: Authentication using One-Time Password Token and Smart Card

• FreeIPA presentation at NYLUG’s meetup in January 2014: PDF

• Devconf 2013: Integrating Linux systems into Active Directory Environment (talk on youtube)

• FOSDEM 2013 Idm Presentation slides in PDF format

• DjangoCon Europe 2013 - Django + Kerberos authentication with slides and video available.

• LinuxAlt 2012: Introducing FreeIPA

• LinuxCon 2012: FreeIPA hands-on workshop session

• Red Hat Summit 2011: FreeIPA presentation

• FOSDEM 2009: FreeIPA presentation - PDF, OO.org 3.0.1