2008-03-17 17:04:49 -05:00
. \" A man page for ipa-server-install
. \" Copyright (C) 2008 Red Hat, Inc.
2010-01-27 16:24:10 -06:00
. \"
2008-03-17 17:04:49 -05:00
. \" This is free software; you can redistribute it and/or modify it under
. \" the terms of the GNU Library General Public License as published by
. \" the Free Software Foundation; version 2 only
2010-01-27 16:24:10 -06:00
. \"
2008-03-17 17:04:49 -05:00
. \" This program is distributed in the hope that it will be useful, but
. \" WITHOUT ANY WARRANTY; without even the implied warranty of
. \" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
. \" General Public License for more details.
2010-01-27 16:24:10 -06:00
. \"
2008-03-17 17:04:49 -05:00
. \" You should have received a copy of the GNU Library General Public
. \" License along with this program; if not, write to the Free Software
. \" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
2010-01-27 16:24:10 -06:00
. \"
2008-03-17 17:04:49 -05:00
. \" Author: Rob Crittenden <rcritten@redhat.com>
2010-01-27 16:24:10 -06:00
. \"
2008-03-17 17:04:49 -05:00
.TH "ipa-server-install" "1" "Mar 14 2008" "freeipa" ""
.SH "NAME"
ipa\- server\- install \- Configure an IPA server
.SH "SYNOPSIS"
ipa\- server\- install [\fI OPTION\fR ]...
.SH "DESCRIPTION"
Configures the services needed by an IPA server. This includes setting up a Kerberos Key Distribution Center (KDC) with an LDAP back\- end, configuring Apache, configuring NTP and starting some IPA\- provided services: ipa_kpasswd and ipa_webgui.
.SH "OPTIONS"
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- u\fR , \fB \- \- user\fR =\fI DS_USER\fR
The user that the Directory Server will run as
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- r\fR , \fB \- \- realm\fR =\fI REALM_NAME\fR
The Kerberos realm name for the IPA server
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- n\fR , \fB \- \- domain\fR =\fI DOMAIN_NAME\fR
Your DNS domain name
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- p\fR , \fB \- \- ds\- password\fR =\fI DM_PASSWORD\fR
The password to be used by the Directory Server for the Directory Manager user
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- P\fR , \fB \- \- master\- password\fR =\fI MASTER_PASSWORD\fR
The kerberos master password (normally autogenerated)
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- a\fR , \fB \- \- admin\- password\fR =\fI ADMIN_PASSWORD\fR
The password for the IPA admin user
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- d\fR , \fB \- \- debug\fR
Enable debug logging when more verbose output is needed
2010-01-27 16:24:10 -06:00
.TP
\fB \- \- ca\fR
Configure a CA instance for issuing server certificates
.TP
2008-03-17 17:04:49 -05:00
\fB \- \- hostname\fR =\fI HOST_NAME\fR
The fully\- qualified DNS name of this server
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- \- ip\- address\fR =\fI IP_ADDRESS\fR
The IP address of this server
2010-01-27 16:24:10 -06:00
.TP
2008-03-17 17:04:49 -05:00
\fB \- U\fR , \fB \- \- unattended\fR
An unattended installation that will never prompt for user input
2009-06-25 07:42:08 -05:00
.TP
\fB \- \- setup\- dns\fR
2009-09-01 16:28:52 -05:00
Generate a DNS zone if it does not exist already and configure the DNS server.
This option requires that you either specify at least one DNS forwarder through
the \fB \- \- forwarder\fR option or use the \fB \- \- no\- forwarders\fR option.
2010-01-27 16:24:10 -06:00
.TP
2009-09-01 16:28:52 -05:00
\fB \- \- forwarder\fR =\fI IP_ADDRESS\fR
Add a DNS forwarder to the DNS configuration. You can use this option multiple
times to specify more forwarders, but at least one must be provided, unless
the \fB \- \- no\- forwarders\fR option is specified.
.TP
\fB \- \- no\- forwarders\fR
Do not add any DNS forwarders. Root DNS servers will be used instead.
.TP
2010-01-27 16:24:10 -06:00
\fB \- \- no\- host\- dns\fR
Do not use DNS for hostname lookup during installation
.TP
\fB \- N\fR , \fB \- \- no\- ntp\fR
2008-03-17 17:04:49 -05:00
Do not configure NTP
2010-01-27 16:24:10 -06:00
.TP
2008-07-11 10:34:29 -05:00
\fB \- U\fR , \fB \- \- uninstall\fR
2008-03-17 17:04:49 -05:00
Uninstall an existing IPA installation
2008-07-11 10:34:29 -05:00
.TP
\fB \- \- dirsrv_pkcs12\fR =\fI FILE\fR
PKCS#12 file containing the Directory Server SSL Certificate
.TP
\fB \- \- http_pkcs12\fR =\fI FILE\fR
PKCS#12 file containing the Apache Server SSL Certificate
.TP
\fB \- \- dirsrv_pin\fR =\fI DIRSRV_PIN\fR
The password of the Directory Server PKCS#12 file
.TP
\fB \- \- http_pin\fR =\fI HTTP_PIN\fR
The password of the Apache Server PKCS#12 file
2010-01-27 16:24:10 -06:00
.TP
2009-08-27 13:12:55 -05:00
\fB \- \- uidstart\fR =\fI UIDSTART\fR
The starting user id number (default random)
2010-01-27 16:24:10 -06:00
.TP
2009-08-27 13:12:55 -05:00
\fB \- \- gidstart\fR =\fI GIDSTART\fR
The starting group id number (default random)
2010-01-27 16:24:10 -06:00
.TP
\fB \- \- subject\fR =\fI SUBJECT\fR
The certificate subject base (default O=IPA)
.TP
2008-03-17 17:04:49 -05:00
.SH "EXIT STATUS"
0 if the installation was successful
1 if an error occurred