mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-01-11 16:51:55 -06:00
f3e1efdcf5
ipa-kra-install man page was missing a specific section for domain level 1. This commits also fixes a wrong option short name (for --log-file) and indents the text corresponding to -p DM_PASSWORD https://pagure.io/freeipa/issue/6922 Reviewed-By: Tomas Krizek <tkrizek@redhat.com>
65 lines
2.8 KiB
Groff
65 lines
2.8 KiB
Groff
.\" A man page for ipa-kra-install
|
|
.\" Copyright (C) 2014 Red Hat, Inc.
|
|
.\"
|
|
.\" This program is free software; you can redistribute it and/or modify
|
|
.\" it under the terms of the GNU General Public License as published by
|
|
.\" the Free Software Foundation, either version 3 of the License, or
|
|
.\" (at your option) any later version.
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" You should have received a copy of the GNU General Public License
|
|
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
.\"
|
|
.\" Author: Ade Lee <alee@redhat.com>
|
|
.\"
|
|
.TH "ipa-kra-install" "1" "May 10 2017" "FreeIPA" "FreeIPA Manual Pages"
|
|
.SH "NAME"
|
|
ipa\-kra\-install \- Install a KRA on a server
|
|
.SH "SYNOPSIS"
|
|
.SS "DOMAIN LEVEL 0"
|
|
.TP
|
|
ipa\-kra\-install [\fIOPTION\fR]... [replica_file]
|
|
.SS "DOMAIN LEVEL 1"
|
|
.TP
|
|
ipa\-kra\-install [\fIOPTION\fR]...
|
|
.SH "DESCRIPTION"
|
|
Adds a KRA as an IPA\-managed service. This requires that the IPA server is already installed and configured, including a CA.
|
|
|
|
The KRA (Key Recovery Authority) is a component used to securely store secrets such as passwords, symmetric keys and private asymmetric keys. It is used as the back-end repository for the IPA Password Vault.
|
|
|
|
In a domain at domain level 0, ipa\-kra\-install can be run without replica_file to add KRA to the existing CA, or with replica_file to install the KRA service on the replica.
|
|
ipa\-kra\-install will contact the CA to determine if a KRA has already been installed on another replica, and if so, will exit indicating that a replica_file is required.
|
|
|
|
The replica_file is created using the ipa\-replica\-prepare utility. A new replica_file should be generated on the master IPA server after the KRA has been installed and configured, so that the replica_file will contain the master KRA configuration and system certificates.
|
|
|
|
In a domain at domain level 1, ipa\-kra\-install can be used to add KRA to the existing CA, or to install the KRA service on a replica, and does not require any replica file.
|
|
|
|
KRA can only be removed along with the entire server using ipa\-server\-install \-\-uninstall.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
\fB\-p\fR \fIDM_PASSWORD\fR, \fB\-\-password\fR=\fIDM_PASSWORD\fR
|
|
Directory Manager (existing master) password
|
|
.TP
|
|
\fB\-\-no-host-dns\fR
|
|
Do not use DNS for hostname lookup during installation
|
|
.TP
|
|
\fB\-U\fR, \fB\-\-unattended\fR
|
|
An unattended installation that will never prompt for user input
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
Enable debug output when more verbose output is needed
|
|
.TP
|
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
Output only errors
|
|
.TP
|
|
\fB\-\-log-file\fR=\fRFILE\fR
|
|
Log to the given file
|
|
.SH "EXIT STATUS"
|
|
0 if the command was successful
|
|
|
|
1 if an error occurred
|