From 7e3c5e3283ff9fa873691c2c2fccbfd304c1b7c7 Mon Sep 17 00:00:00 2001 From: Tomas Babej Date: Wed, 17 Oct 2012 08:27:26 -0400 Subject: Refactoring of default.conf man page Description for the 'dogtag_version', 'startup_timeout', 'server', 'wait_for_attr' option has been added. Option 'server' has been marked as deprecated, as it is not used anywhere in IPA code. All the options have been sorted lexicographically. https://fedorahosted.org/freeipa/ticket/3071 --- ipa-client/man/default.conf.5 | 86 ++++++++++++++++++++++++------------------- 1 file changed, 49 insertions(+), 37 deletions(-) (limited to 'ipa-client/man') diff --git a/ipa-client/man/default.conf.5 b/ipa-client/man/default.conf.5 index fb913e6cc..f779b51f5 100644 --- a/ipa-client/man/default.conf.5 +++ b/ipa-client/man/default.conf.5 @@ -71,21 +71,45 @@ Specifies the secure CA agent port. The default is 9443 for Dogtag 9, and 8443 f .B ca_ee_port Specifies the secure CA end user port. The default is 9444 for Dogtag 9, and 8443 for Dogtag 10. .TP -.B ca_port -Specifies the insecure CA end user port. The default is 9180 for Dogtag 9, and 8080 for Dogtag 10. -.TP .B ca_host Specifies the hostname of the dogtag CA server. The default is the hostname of the IPA server. .TP +.B ca_port +Specifies the insecure CA end user port. The default is 9180 for Dogtag 9, and 8080 for Dogtag 10. +.TP .B context Specifies the context that IPA is being executed in. IPA may operate differently depending on the context. The current defined contexts are cli and server. Additionally this value is used to load /etc/ipa/\fBcontext\fR.conf to provide context\-specific configuration. For example, if you want to always perform client requests in verbose mode but do not want to have verbose enabled on the server, add the verbose option to \fI/etc/ipa/cli.conf\fR. .TP -.B verbose -When True provides more information. Specifically this sets the global log level to "info". -.TP .B debug When True provides detailed information. Specifically this set the global log level to "debug". Default is False. .TP +.B dogtag_version +Stores the version of Dogtag. Value 9 is assumed if not specified otherwise. +.TP +.B domain +The domain of the IPA server e.g. example.com. +.TP +.B enable_ra +Specifies whether the CA is acting as an RA agent, such as when dogtag is being used as the Certificate Authority. This setting only applies to the IPA server configuration. +.TP +.B fallback +Specifies whether an IPA client should attempt to fall back and try other services if the first connection fails. +.TP +.B host +Specifies the hostname of the IPA server. This value is used to construct URL values on the client and server. +.TP +.B in_server +Specifies whether requests should be forwarded to an IPA server or handled locally. This is used internally by IPA in a similar way as context. The same IPA framework is used by the ipa command\-line tool and the server. This setting tells the framework whether it should execute the command as if on the server or forward it via XML\-RPC to a remote server. +.TP +.B in_tree +This is used in development and is generally a detected value. It means that the code is being executed within a source tree. +.TP +.B interactive +Specifies whether values should be prompted for or not. The default is True. +.TP +.B ldap_uri +Specifies the URI of the IPA LDAP server to connect to. The URI scheme may be one of \fBldap\fR or \fBldapi\fR. The default is to use ldapi, e.g. ldapi://%2fvar%2frun%2fslapd\-EXAMPLE\-COM.socket +.TP .B log_logger_XXX loggers matching regexp will be assigned XXX level. .IP @@ -118,32 +142,8 @@ expression metacharacter (matches any character) therefore you will usually need to escape the dot in the logger names by preceeding it with a backslash. .TP -.B domain -The domain of the IPA server e.g. example.com. -.TP -.B enable_ra -Specifies whether the CA is acting as an RA agent, such as when dogtag is being used as the Certificate Authority. This setting only applies to the IPA server configuration. -.TP -.B fallback -Specifies whether an IPA client should attempt to fall back and try other services if the first connection fails. -.TP -.B host -Specifies the hostname of the IPA server. This value is used to construct URL values on the client and server. -.TP -.B in_server -Specifies whether requests should be forwarded to an IPA server or handled locally. This is used internally by IPA in a similar way as context. The same IPA framework is used by the ipa command\-line tool and the server. This setting tells the framework whether it should execute the command as if on the server or forward it via XML\-RPC to a remote server. -.TP -.B in_tree -This is used in development and is generally a detected value. It means that the code is being executed within a source tree. -.TP -.B interactive -Specifies whether values should be prompted for or not. The default is True. -.TP -.B ldap_uri -Specifies the URI of the IPA LDAP server to connect to. The URI scheme may be one of \fBldap\fR or \fBldapi\fR. The default is to use ldapi, e.g. ldapi://%2fvar%2frun%2fslapd\-EXAMPLE\-COM.socket -.TP .B mode -Specifies the mode the server is running in. The currently support values are \fBpr\fRoduction and \fBdevelopment\fR. When running in production mode some self\-tests are skipped to improve performance. +Specifies the mode the server is running in. The currently support values are \fBproduction\fR and \fBdevelopment\fR. When running in production mode some self\-tests are skipped to improve performance. .TP .B mount_ipa Specifies the mount point that the development server will register. The default is /ipa/ @@ -157,20 +157,32 @@ Specifies the name of the CA back end to use. The current options are \fBselfsig .B realm Specifies the Kerberos realm. .TP +.B session_auth_duration