Update pkispawn man page with instructions to dscreate #3348
Conversation
This patch updates pkispawn's man page with instructions to install a DS instance using dscreate. Partly resolves: bz#1656772 Signed-off-by: Dinesh Prasanth M K <dmoluguw@redhat.com>
There was a problem hiding this comment.
The man page seems to be quite old and needs to revised again. Maybe @fdelehay can help us verify and point outdated instructions? 😄
docs/manuals/man8/pkispawn.8.md
Outdated
| Stop the Directory Server instance: | ||
|
|
||
| ``` | ||
| $ systemctl stop dirsrv@pki.service | ||
| ``` | ||
|
|
||
| Enable LDAPS in the Directory Server with the following command: |
There was a problem hiding this comment.
The script doesn't seem to work anymore. IMO, the contents (or steps) from the script should be moved into the man page, for systems with offline access.
There was a problem hiding this comment.
I have an unofficial instruction on DS setup here:
https://github.com/dogtagpki/pki/wiki/DS-1.4-Installation
But I don't think we should be including DS setup instruction in PKI docs because it's outside our scope. I'd rather we just refer to DS docs, and only specify what PKI needs in PKI docs, for example:
- Hostname and port number
- Bind DN and password, or client certificate
- Base DN
So probably lines 1342-1385 can be replaced with something like: Set up a Directory Server instance with a self-signed CA certificate (see dscreate(8)), then export the certificate into a PEM file.
Also, we can remove all references to dirsrv.target.
docs/manuals/man8/pkispawn.8.md
Outdated
| To obtain a detailed status of all Tomcat PKI instances: | ||
|
|
||
| ``` | ||
| $ pkidaemon status tomcat | ||
| $ pki-server status |
There was a problem hiding this comment.
I think this part can be removed. pki-server status will only work with one instance at a time.
docs/manuals/man8/pkispawn.8.md
Outdated
| Stop the Directory Server instance: | ||
|
|
||
| ``` | ||
| $ systemctl stop dirsrv@pki.service | ||
| ``` | ||
|
|
||
| Enable LDAPS in the Directory Server with the following command: |
There was a problem hiding this comment.
I have an unofficial instruction on DS setup here:
https://github.com/dogtagpki/pki/wiki/DS-1.4-Installation
But I don't think we should be including DS setup instruction in PKI docs because it's outside our scope. I'd rather we just refer to DS docs, and only specify what PKI needs in PKI docs, for example:
- Hostname and port number
- Bind DN and password, or client certificate
- Base DN
So probably lines 1342-1385 can be replaced with something like: Set up a Directory Server instance with a self-signed CA certificate (see dscreate(8)), then export the certificate into a PEM file.
Also, we can remove all references to dirsrv.target.
This patch: - Fixes issue with angle brackets in pkispawn man page - Removes obsolete DS specific information from pkispawn man page Signed-off-by: Dinesh Prasanth M K <dmoluguw@redhat.com>
|
Merging based on the ACK! Thanks @edewata |
This patch updates pkispawn's man page with instructions
to install a DS instance using dscreate.
Partly resolves: bz#1656772
Signed-off-by: Dinesh Prasanth M K <dmoluguw@redhat.com>