Skip to content

Commit

Permalink
Replace "This page describes the process" with "Follow this process"
Browse files Browse the repository at this point in the history
per downstream convergence. [skip ci]
  • Loading branch information
ladycfu committed Feb 20, 2025
1 parent 77e237f commit 6af7cb5
Show file tree
Hide file tree
Showing 53 changed files with 52 additions and 54 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
= Installing ACME Responder using pkispawn =


This document describes the process to install an ACME responder on a PKI server that already has a CA subsystem using `pkispawn` command.
Follow this process to install an ACME responder on a PKI server that already has a CA subsystem using `pkispawn` command.

In general `pkispawn` provides a simpler way compared to link:Installing-ACME-Responder-using-PKI-Server-ACME-CLI.adoc[`pki-server acme`] for installing ACME responder.
If there is a problem during installation, the entire process might need to be restarted.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing-CA-with-RSA-PSS.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with RSA/PSS

This page describes the process to install a CA subsystem with RSA/PSS.
Follow this process to install a CA subsystem with RSA/PSS.

= Installation Procedure

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Overview

This page describes the process to install a CA subsystem with link:https://github.com/dogtagpki/pki/wiki/Random-Certificate-Serial-Numbers-v3[Random Certificate Serial Numbers v3] in PKI 11.2 or later.
Follow this process to install a CA subsystem with link:https://github.com/dogtagpki/pki/wiki/Random-Certificate-Serial-Numbers-v3[Random Certificate Serial Numbers v3] in PKI 11.2 or later.

NOTE: RSNv3 is enabled by default since PKI 11.5.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA

This page describes the process to install a CA subsystem instance with a self-signed CA signing certificate. It is also known as a "root CA".
Follow this process to install a CA subsystem instance with a self-signed CA signing certificate. It is also known as a "root CA".

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA_Clone.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA Clone

This page describes the process to install a CA subsystem as a clone of an existing CA subsystem.
Follow this process to install a CA subsystem as a clone of an existing CA subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA_Clone_with_HSM.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing CA Clone with HSM


This page describes the process to install a CA subsystem as a clone of an existing CA subsystem
Follow this process to install a CA subsystem as a clone of an existing CA subsystem
where the system certificates and their keys are stored in HSM.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing CA Clone with Secure Database Connection


This page describes the process to install a CA subsystem as clone of an existing CA subsystem with a secure database connection.
Follow this process to install a CA subsystem as clone of an existing CA subsystem with a secure database connection.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with Custom CA Signing Key

This page describes the process to install a CA subsystem with a custom CA signing key, CSR, and certificate.
Follow this process to install a CA subsystem with a custom CA signing key, CSR, and certificate.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA_with_ECC.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with ECC

This page describes the process to install a CA subsystem with ECC self-signed CA signing certificate.
Follow this process to install a CA subsystem with ECC self-signed CA signing certificate.

Supported ECC curves:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with Existing Keys in HSM

This page describes the process to install a CA subsystem with the system keys, CSRs, and certificates from an existing CA
Follow this process to install a CA subsystem with the system keys, CSRs, and certificates from an existing CA
where the keys are stored in HSM.

To avoid conflicts with the existing CA subsystem, the new CA subsystem will use new SSL server and subsystem certificates,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing CA with Existing Keys in Internal Token


This page describes the process to install a CA subsystem with the system keys, CSRs, and certificates from an existing CA
Follow this process to install a CA subsystem with the system keys, CSRs, and certificates from an existing CA
where the keys are stored in internal token.

To avoid conflicts with the existing CA subsystem, the new CA subsystem will use new SSL server and subsystem certificates,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with External CA Signing Certificate

This page describes the process to install a CA subsystem with an external CA signing certificate.
Follow this process to install a CA subsystem with an external CA signing certificate.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA_with_HSM.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing CA with HSM

This page describes the process to install a CA subsystem with a self-signed CA signing certificate
Follow this process to install a CA subsystem with a self-signed CA signing certificate
where the system certificates and their keys will be stored in HSM.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

This page describes the process to install a CA subsystem with a secure database connection.
Follow this process to install a CA subsystem with a secure database connection.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_Subordinate_CA.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing Subordinate CA

This page describes the process to install a subordinate CA subsystem
Follow this process to install a subordinate CA subsystem
with a signing certificate issued by a root CA.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/est/Installing-EST.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
= Installing EST


This page describes the process to install an _EST subsystem_.
Follow this process to install an _EST subsystem_.

The *EST subsystem* requires the package `dogtag-pki-est` installed in the server which will run the instance:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Overview

This page describes the process to install a KRA subsystem with random serial numbers in PKI 11.2 or later.
Follow this process to install a KRA subsystem with random serial numbers in PKI 11.2 or later.

NOTE: RSNv3 is enabled by default since PKI 11.5.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA


This page describes the process to install a KRA subsystem.
Follow this process to install a KRA subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA_Clone.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA Clone


This page describes the process to install a KRA subsystem as a clone of an existing KRA subsystem.
Follow this process to install a KRA subsystem as a clone of an existing KRA subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA_Clone_with_HSM.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA Clone with HSM


This page describes the process to install a KRA subsystem as a clone of an existing KRA subsystem
Follow this process to install a KRA subsystem as a clone of an existing KRA subsystem
where the system certificates and their keys are stored in HSM.

Since the certificates and the keys are already in HSM, it's not necessary to export them into a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA on Separate Instance


This page describes the process to install a KRA subsystem on an instance/host separate from the CA.
Follow this process to install a KRA subsystem on an instance/host separate from the CA.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA_with_Custom_Keys.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA with Custom Keys


This page describes the process to install a KRA subsystem with custom KRA system and admin keys, CSRs, and certificates.
Follow this process to install a KRA subsystem with custom KRA system and admin keys, CSRs, and certificates.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA_with_ECC.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA with ECC


This page describes the process to install a KRA subsystem with ECC.
Follow this process to install a KRA subsystem with ECC.

Supported ECC curves:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA with External Certificates


This page describes the process to install a KRA subsystem with external certificates.
Follow this process to install a KRA subsystem with external certificates.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_KRA_with_HSM.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA with HSM


This page describes the process to install a KRA subsystem
Follow this process to install a KRA subsystem
where the system certificates and their keys will be stored in HSM.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing KRA with Secure Database Connection


This page describes the process to install a KRA subsystem with a secure database connection.
Follow this process to install a KRA subsystem with a secure database connection.

Ensure that the secure connection has been enabled on the directory server.
Export the signing certificate for the directory server into ds_signing.crt.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/kra/Installing_Standalone_KRA.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing Standalone KRA


This page describes the process to install a standalone KRA subsystem.
Follow this process to install a standalone KRA subsystem.
In link:Installing_KRA.md[regular KRA installation] the KRA certificates are issued automatically by the CA and the KRA will join the CA's security domain.
In standalone KRA installation, the KRA certificates will be issued manually and the KRA have its own security domain.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_OCSP.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing OCSP


This page describes the process to install an OCSP subsystem.
Follow this process to install an OCSP subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_OCSP_Clone.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing OCSP Clone


This page describes the process to install a OCSP subsystem as a clone of an existing OCSP subsystem.
Follow this process to install a OCSP subsystem as a clone of an existing OCSP subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_OCSP_Clone_with_HSM.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Installing OCSP Clone with HSM


This page describes the process to install an OCSP subsystem as a clone of an existing OCSP subsystem
Follow this process to install an OCSP subsystem as a clone of an existing OCSP subsystem
where the system certificates and their keys are stored in HSM.

Since the certificates and the keys are already in HSM, it's not necessary to export them into a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Installing OCSP with Custom Keys


This page describes the process to install a OCSP subsystem with custom OCSP system and admin keys, CSRs, and certificates.
Follow this process to install a OCSP subsystem with custom OCSP system and admin keys, CSRs, and certificates.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_OCSP_with_ECC.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing OCSP with ECC


This page describes the process to install a OCSP subsystem with ECC.
Follow this process to install a OCSP subsystem with ECC.

Supported ECC curves:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing OCSP with External Certificates

This page describes the process to install a OCSP subsystem with external certificates.
Follow this process to install a OCSP subsystem with external certificates.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_OCSP_with_HSM.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installing OCSP with HSM

This page describes the process to install an OCSP subsystem
Follow this process to install an OCSP subsystem
where the system certificates and their keys will be stored in HSM.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing OCSP with Secure Database Connection


This page describes the process to install an OCSP subsystem with a secure database connection.
Follow this process to install an OCSP subsystem with a secure database connection.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/ocsp/Installing_Standalone_OCSP.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing Standalone OCSP


This page describes the process to install a standalone OCSP subsystem.
Follow this process to install a standalone OCSP subsystem.
In link:Installing_OCSP.adoc[regular OCSP installation] the OCSP certificates are issued automatically by the CA and the OCSP will join the CA's security domain.
In standalone OCSP installation, the OCSP certificates will be issued manually and the OCSP have its own security domain.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/others/Creating_DS_instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

*Note: Prior to installing DS instances, make sure the procedure for link:Installing_DS_Packages.adoc[installing DS packages] has been performed on the host system.*

This section describes the process to prepare a local DS instance for PKI server.
Follow this process to prepare a local DS instance for PKI server.

Normally the DS installation will automatically generate a self-signed signing certificate and a server certificate for SSL connection.
In this procedure the certificate generation and the SSL connection will be disabled by default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Enabling SSL Connection in DS


This page describes the process to enable SSL connection in DS
Follow this process to enable SSL connection in DS
using a self-signed signing certificate and server certificate
created using link:PKI-NSS-CLI.adoc[PKI NSS CLI] commands.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/others/Exporting-DS-Certificates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Exporting DS Certificates


This page describes the process to export the signing certificate and the server certificate from the NSS database of a DS instance.
Follow this process to export the signing certificate and the server certificate from the NSS database of a DS instance.

By default the certificates are generated automatically during installation,
but they can also be created after installation.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/others/FQDN_Configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
In order to have a properly functioning PKI system,
each machine in the system must have a correct fully qualified domain name.

This page describes the process to configure the fully qualified domain name on each machine.
Follow this process to configure the fully qualified domain name on each machine.

== Verifying FQDN

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/others/Installation_Prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installation Prerequisites

This page contains the generic prerequisites required prior to installing a PKI subsystem. Some installation might need additional or different setups.
This section contains the generic prerequisites required prior to installing a PKI subsystem. Some installation might need additional or different setups.

* link:FQDN_Configuration.adoc[Setting the FQDN of the host system]
Expand Down
1 change: 0 additions & 1 deletion docs/installation/others/PKI-LDAP-Tree.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
//
= PKI LDAP Tree


When all PKI subsystems are created, the LDAP tree will look like the following:

----
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/server/Installing_Basic_PKI_Server.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing Basic PKI Server


This page describes the process to create and configure a basic PKI server without any of the PKI subsystems.
Follow this process to create and configure a basic PKI server without any of the PKI subsystems.
This would be useful to troubleshoot general server issues (e.g. SSL).

== Installation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing PKI Server with Custom NSS Databases


This page describes the process to create a PKI server with custom NSS databases.
Follow this process to create a PKI server with custom NSS databases.

Normally, when installing a PKI subsystem (e.g. CA) some NSS databases will be created by default, for example:

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tks/Installing_TKS.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing TKS


This page describes the process to install a TKS subsystem.
Follow this process to install a TKS subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tks/Installing_TKS_Clone.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installing TKS Clone


This page describes the process to install a TKS subsystem as a clone of an existing TKS subsystem.
Follow this process to install a TKS subsystem as a clone of an existing TKS subsystem.

Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

Expand Down
Loading

0 comments on commit 6af7cb5

Please sign in to comment.