Skip to content

Commit

Permalink
- replace "will be deployed" with "is deployed" under pki/docs/instal…
Browse files Browse the repository at this point in the history
…lation

- remove backticks surrounding words (instead of names) under pki/docs/installation
- remove the extra ", for example" under pki/docs/installation
[skip ci]
  • Loading branch information
ladycfu committed Feb 25, 2025
1 parent 4d74199 commit 753a0a6
Show file tree
Hide file tree
Showing 30 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/installation/ca/Installing_CA.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq
== CA Subsystem Installation

Prepare a deployment configuration, for example `ca.cfg`, to deploy CA subsystem.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ca.cfg[/usr/share/pki/server/examples/installation/ca.cfg].

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/ca/Installing_CA_Clone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The command will export the following certificates (including the certificate ch

Note that the existing SSL server certificate will not be exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand Down Expand Up @@ -76,7 +76,7 @@ $ chown pkiuser:pkiuser ca-certs.p12
== CA Subsystem Installation

Prepare a deployment configuration, for example `ca-clone.cfg`, to deploy CA subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ca-clone.cfg[/usr/share/pki/server/examples/installation/ca-clone.cfg].
It assumes that the primary CA subsystem is running at https://primary.example.com:8443,
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
Expand Up @@ -33,7 +33,7 @@ $ pki-server cert-export subsystem \

Note: It is assumed that the CA signing certificate has been exported into `ca_signing.crt`

Prepare a file, for example `ca.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ca.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ The command will export the following certificates (including the certificate ch
* audit signing certificate
* subsystem certificate

Note that the existing SSL server certificate will not be exported.
Note that the existing SSL server certificate is not exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand Down Expand Up @@ -88,7 +88,7 @@ $ chown pkiuser:pkiuser ca-certs.p12
== CA Subsystem Installation

Prepare a deployment configuration, for example `ca-secure-ds-secondary.cfg`, to deploy CA subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ca-secure-ds-secondary.cfg[/usr/share/pki/server/examples/installation/ca-secure-ds-secondary.cfg].
It assumes that the existing CA and DS instances are running on primary.example.com, and the new CA and DS clones are being installed on secondary.example.com,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Follow this process to install a CA subsystem with a custom CA signing key, CSR,
Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

== Starting CA Subsystem Installation
Prepare a file, for example `ca-step1.cfg`, that contains the deployment configuration step 1, for example:
Prepare a file, for example `ca-step1.cfg`, that contains the deployment configuration step 1:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -19,7 +19,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq
== CA Subsystem Installation

Prepare a deployment configuration, for example `ca-ecc.cfg`, to deploy CA subsystem.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ca-ecc.cfg[/usr/share/pki/server/examples/installation/ca-ecc.cfg].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ so they will not be included in the installation process.
Prior to installation, please ensure that the link:../others/Installation_Prerequisites.adoc[Installation Prerequisites] are configured.

== Starting CA Subsystem Installation
Prepare a file, for example `ca-step1.cfg`, that contains the deployment configuration step 1, for example:
Prepare a file, for example `ca-step1.cfg`, that contains the deployment configuration step 1:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -6,7 +6,7 @@ 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.

== CA Subsystem Installation
Prepare a file, for example `ca.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ca.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ link:../others/Exporting-DS-Certificates.adoc#exporting-ds-signing-certificate[E

== CA Subsystem Installation
Prepare a deployment configuration, for example `ca-secure-ds.cfg`, to deploy CA subsystem.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ca-secure-ds.cfg[/usr/share/pki/server/examples/installation/ca-secure-ds.cfg].

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/kra/Installing_KRA_Clone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The command will export the following certificates (including the certificate ch

Note that the existing SSL server certificate will not be exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand All @@ -39,7 +39,7 @@ $ pki -d /var/lib/pki/pki-tomcat/conf/alias -f /var/lib/pki/pki-tomcat/conf/pass
== KRA Subsystem Installation

Prepare a deployment configuration, for example `kra-clone.cfg`, to deploy KRA subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/kra-clone.cfg[/usr/share/pki/server/examples/installation/kra-clone.cfg].
It assumes that the primary CA and KRA subsystems are running at https://primary.example.com:8443,
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
Expand Up @@ -13,7 +13,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

Note: It is assumed that the CA signing certificate has been exported into `ca_signing.crt`

Prepare a file, for example `kra.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `kra.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -7,7 +7,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== Starting KRA Subsystem Installation

Prepare a file, for example `kra-step1.cfg`, that contains the deployment configuration step 1, for example:
Prepare a file, for example `kra-step1.cfg`, that contains the deployment configuration step 1:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -19,7 +19,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== KRA Subsystem Installation

Prepare a file, for example `kra.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `kra.cfg`, that contains the deployment configuration:
[literal,subs="+quotes,verbatim"]
....
[DEFAULT]
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
Expand Up @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== KRA Subsystem Installation

Prepare a file, for example `kra.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `kra.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This step is described link:https://www.dogtagpki.org/wiki/DS_SSL[here].

== KRA Subsystem Installation

Prepare a file, for example `kra.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `kra.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/ocsp/Installing_OCSP_Clone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The command will export the following certificates (including the certificate ch

Note that the existing SSL server certificate will not be exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand All @@ -38,7 +38,7 @@ $ pki -d /var/lib/pki/pki-tomcat/conf/alias -f /var/lib/pki/pki-tomcat/conf/pass
== OCSP Subsystem Installation

Prepare a deployment configuration, for example `ocsp-clone.cfg`, to deploy OCSP subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/ocsp-clone.cfg[/usr/share/pki/server/examples/installation/ocsp-clone.cfg].
It assumes that the primary CA and OCSP subsystems are running at https://primary.example.com:8443,
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 @@ -14,7 +14,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

Note: It is assumed that the CA signing certificate has been exported into `ca_signing.crt

Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== Starting OCSP Subsystem Installation

Prepare a file, for example `ocsp-step1.cfg`, that contains the deployment configuration step 1, for example:
Prepare a file, for example `ocsp-step1.cfg`, that contains the deployment configuration step 1:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -19,7 +19,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== OCSP Subsystem Installation

Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -7,7 +7,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== OCSP Subsystem Installation

Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Ensure that the secure connection has been enabled on the directory server, and

== OCSP Subsystem Installation

Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `ocsp.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
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
Expand Up @@ -2,7 +2,7 @@


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, for example `SSL`.
This would be useful to troubleshoot general server issues, for example SSL.

== Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

Follow this process to create a PKI server with custom NSS databases.

Normally, when installing a PKI subsystem, for example `CA`, some NSS databases will be created by default, for example:
Normally, when installing a PKI subsystem, for example CA, some NSS databases will be created by default:

* server NSS database: /var/lib/pki/pki-tomcat/conf/alias
* admin NSS database: ~/.dogtag/pki-tomcat/ca/alias
Under some circumstances the admin may want to use custom NSS databases, for example `with trust policy`.
Under some circumstances the admin may want to use custom NSS databases, for example with trust policy.
In those cases the installation can be done in multiple steps:

* create a basic PKI server
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/tks/Installing_TKS_Clone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The command will export the following certificates (including the certificate ch

Note that the existing SSL server certificate will not be exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand All @@ -37,7 +37,7 @@ $ pki -d /var/lib/pki/pki-tomcat/conf/alias -f /var/lib/pki/pki-tomcat/conf/pass
== TKS Subsystem Installation

Prepare a deployment configuration, for example `tks-clone.cfg`, to deploy TKS subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/tks-clone.cfg[/usr/share/pki/server/examples/installation/tks-clone.cfg].
It assumes that the primary CA and TKS are running at https://primary.example.com:8443,
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tks/Installing_TKS_with_ECC.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== TKS Subsystem Installation

Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `tks.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tks/Installing_TKS_with_HSM.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== TKS Subsystem Installation

Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `tks.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This step is described link:https://www.dogtagpki.org/wiki/DS_SSL[here].

== TKS Subsystem Installation

Prepare a file, for example `tks.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `tks.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/tps/Installing_TPS_Clone.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The command will export the following certificates (including the certificate ch

Note that the existing SSL server certificate will not be exported.

If necessary, third-party certificates, for example `trust anchors`, can be added into the same PKCS #12 file with the following command:
If necessary, third-party certificates, for example trust anchors, can be added into the same PKCS #12 file with the following command:

[literal,subs="+quotes,verbatim"]
....
Expand All @@ -38,7 +38,7 @@ $ pki -d /var/lib/pki/pki-tomcat/conf/alias -f /var/lib/pki/pki-tomcat/conf/pass
== TPS Subsystem Installation

Prepare a deployment configuration, for example `tps-clone.cfg`, to deploy TPS subsystem clone.
By default the subsystem will be deployed into a Tomcat instance called `pki-tomcat`.
By default the subsystem is deployed into a Tomcat instance called `pki-tomcat`.

A sample deployment configuration is available at link:../../../base/server/examples/installation/tps-clone.cfg[/usr/share/pki/server/examples/installation/tps-clone.cfg].
It assumes that the primary CA, KRA, TKS, and TPS subsystems are running at https://primary.example.com:8443,
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tps/Installing_TPS_with_HSM.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Prior to installation, please ensure that the link:../others/Installation_Prereq

== TPS Subsystem Installation

Prepare a file, for example `tps.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `tps.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This step is described link:https://www.dogtagpki.org/wiki/DS_SSL[here].

== TPS Subsystem Installation

Prepare a file, for example `tps.cfg`, that contains the deployment configuration, for example:
Prepare a file, for example `tps.cfg`, that contains the deployment configuration:

[literal,subs="+quotes,verbatim"]
....
Expand Down

0 comments on commit 753a0a6

Please sign in to comment.