Skip to content

Commit

Permalink
under pki/docs/installation
Browse files Browse the repository at this point in the history
- adding the following three lines to the top of adoc files with all lower case file names:
-- :_mod-docs-content-type: PROCEDURE
-- \n
-- [id="xxx_{context}"] where 'xxx' is the file name minus the .adoc extention
[skip ci]
  • Loading branch information
ladycfu committed Feb 27, 2025
1 parent 1ba4784 commit 1b82d23
Show file tree
Hide file tree
Showing 59 changed files with 177 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-acme-responder-using-pki-server-acme-cli_{context}"]
= Installing ACME Responder using PKI Server ACME CLI =


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-acme-responder-using-pkispawn_{context}"]
= Installing ACME Responder using pkispawn =

Follow this process to install an ACME responder on a PKI server that already has a CA subsystem using `pkispawn` command.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/acme/installing-acme-responder.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-acme-responder_{context}"]
= Installing ACME Responder =


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-clone-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-clone-with-hsm_{context}"]
= Installing CA Clone with HSM


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-clone-with-ldaps-connection_{context}"]
= Installing CA Clone with LDAPS Connection

Follow this process to install a CA subsystem as clone of an existing CA subsystem with a secure database connection.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-clone.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-clone_{context}"]
= Installing CA Clone

Follow this process to install a CA subsystem as a clone of an existing CA subsystem.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-custom-ca-signing-key_{context}"]
= Installing CA with Custom CA Signing Key

Follow this process to install a CA subsystem with a custom CA signing key, CSR, and certificate.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-with-ecc.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-ecc_{context}"]
= Installing CA with ECC

Follow this process to install a CA subsystem with ECC self-signed CA signing certificate.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-existing-keys-in-hsm_{context}"]
= Installing CA with Existing Keys in HSM

Follow this process to install a CA subsystem with the system keys, CSRs, and certificates from an existing CA
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-existing-keys-in-internal-token_{context}"]
= Installing CA with Existing Keys in Internal Token


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-external-ca-signing-certificate_{context}"]
= Installing CA with External CA Signing Certificate

Follow this process to install a CA subsystem with an external CA signing certificate.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-hsm_{context}"]
= Installing CA with HSM

Follow this process to install a CA subsystem with a self-signed CA signing certificate
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-with-ldaps-connection.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-ldaps-connection_{context}"]
= Installing CA with LDAPS Connection

Follow this process to install a CA subsystem with a secure database connection.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-random-serial-numbers-v3_{context}"]
= Overview

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.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca-with-rsa-pss.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca-with-rsa-pss_{context}"]
= Installing CA with RSA/PSS

Follow this process to install a CA subsystem with RSA/PSS.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-ca.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ca_{context}"]
= Installing 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".
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ca/installing-subordinate-ca.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-subordinate-ca_{context}"]
= Installing Subordinate CA

Follow this process to install a subordinate CA subsystem
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/est/configure-est-realm-db.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="configure-est-realm-db_{context}"]
= Configure EST Realm DB

== Preparing DS DB
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/est/installing-est-pki-server.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-est-pki-server_{context}"]
= EST installation using `pki-server`

After the prerequisite in xref:../est/installing-est.adoc[Installing EST], it is
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/est/installing-est-pkispawn.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-est-pkispawn_{context}"]
= EST installation using `pkispawn`

After the prerequisite in xref:../est/installing-est.adoc[Installing
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/est/installing-est.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-est_{context}"]
// this asciidoc file is converted from Installing_EST.md with needed modifications
//

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra-clone-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-clone-with-hsm_{context}"]
= Installing KRA Clone with HSM


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra-clone.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-clone_{context}"]
= Installing KRA Clone


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-on-separate-instance_{context}"]
= Installing KRA on Separate Instance


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra-with-custom-keys.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-custom-keys_{context}"]
= Installing KRA with Custom Keys


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra-with-ecc.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-ecc_{context}"]
= Installing KRA with ECC


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-external-certificates_{context}"]
= Installing KRA with External Certificates


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-hsm_{context}"]
= Installing KRA with HSM


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-ldaps-connection_{context}"]
= Installing KRA with LDAPS Connection


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra-with-random-serial-numbers-v3_{context}"]
= Overview

Follow this process to install a KRA subsystem with random serial numbers in PKI 11.2 or later.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-kra.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-kra_{context}"]
= Installing KRA


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/kra/installing-standalone-kra.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-standalone-kra_{context}"]
= Installing Standalone KRA


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp-clone-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-clone-with-hsm_{context}"]
= Installing OCSP Clone with HSM


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp-clone.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-clone_{context}"]
= Installing OCSP Clone


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp-with-custom-keys.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-with-custom-keys_{context}"]
= Installing OCSP with Custom Keys


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp-with-ecc.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-with-ecc_{context}"]
= Installing OCSP with ECC


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-with-external-certificates_{context}"]
= Installing OCSP with External Certificates

Follow this process to install a OCSP subsystem with external certificates.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-with-hsm_{context}"]
= Installing OCSP with HSM

Follow this process to install an OCSP subsystem
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp-with-ldaps-connection_{context}"]
= Installing OCSP with LDAPS Connection


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-ocsp.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ocsp_{context}"]
= Installing OCSP


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/ocsp/installing-standalone-ocsp.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-standalone-ocsp_{context}"]
= Installing Standalone OCSP


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/creating-ds-instance.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="creating-ds-instance_{context}"]
// This content is copied and modifed from https://github.com/dogtagpki/pki/wiki/Installing-DS-Server
//
= Directory Server Instance Creation
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/enabling-ssl-connection-in-ds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="enabling-ssl-connection-in-ds_{context}"]
// This content was copied and adjusted from https://github.com/dogtagpki/pki/wiki/Enabling-SSL-Connection-in-DS
= Enabling SSL Connection in DS

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/exporting-ds-certificates.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="exporting-ds-certificates_{context}"]
// initial content copied from https://github.com/dogtagpki/pki/wiki/Exporting-DS-Certificates
= Exporting DS Certificates

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/fqdn-configuration.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="fqdn-configuration_{context}"]
// this content was copied and modified from https://github.com/dogtagpki/pki/wiki
//
= FQDN Configuration
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/installation-prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installation-prerequisites_{context}"]
= Installation Prerequisites

This section contains the generic prerequisites required prior to installing a PKI subsystem. Some installation might need additional or different setups.
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/installing-ds-packages.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-ds-packages_{context}"]
// This was copied partially from https://github.com/dogtagpki/pki/wiki/Installing-DS-Server
= Installing DS Packages

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/others/pki-ldap-tree.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="pki-ldap-tree_{context}"]
// This content is copied from https://github.com/dogtagpki/pki/wiki/PKI-LDAP-Tree
//
= PKI LDAP Tree
Expand Down
3 changes: 3 additions & 0 deletions docs/installation/server/installing-basic-pki-server.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-basic-pki-server_{context}"]
= Installing Basic PKI Server


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-pki-server-with-custom-nss-databases_{context}"]
= Installing PKI Server with Custom NSS Databases


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tks/installing-tks-clone.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tks-clone_{context}"]
= Installing TKS Clone


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tks/installing-tks-with-ecc.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tks-with-ecc_{context}"]
= Installing TKS with ECC


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tks/installing-tks-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tks-with-hsm_{context}"]
= Installing TKS with HSM


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tks-with-ldaps-connection_{context}"]
= Installing TKS with LDAPS Connection


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tks/installing-tks.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tks_{context}"]
= Installing TKS


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tps/installing-tps-clone.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tps-clone_{context}"]
= Installing TPS Clone


Expand Down
3 changes: 3 additions & 0 deletions docs/installation/tps/installing-tps-with-hsm.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="installing-tps-with-hsm_{context}"]
= Installing TPS with HSM


Expand Down
Loading

0 comments on commit 1b82d23

Please sign in to comment.