Skip to content

Commit 9b5df46

Browse files
authored
Merge pull request #6730 from EnterpriseDB/docs/edits_to_pem10_group2
Docs/edits to pem10 batch 2
2 parents 88c1293 + 9301470 commit 9b5df46

11 files changed

+84
-85
lines changed

product_docs/docs/pem/10/certificates/regenerating_agent_certificates.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ redirects:
66
---
77

88
!!! Important
9-
These steps are automatically performed by default when the certificates are nearing expiry.
10-
These instructions are provided for completeness incase you need to manually regenerate the PEM certificates and keys.
9+
PEM performs these steps by default when the certificates are nearing expiry.
10+
These instructions are provided for completeness in case you need to manually regenerate the PEM certificates and keys.
1111
!!!
1212

1313
You need to regenerate the agent certificates and key files:
14-
- If the PEM server certificates are regenerated
15-
- If the PEM agent certificates are near expiring
14+
- If the PEM server certificates are regenerated.
15+
- If the PEM agent certificates are near expiring.
1616

1717
You must regenerate a certificate and a key for each agent interacting with the PEM server and copy it to the agent.
1818

19-
Each agent has a unique identifier that's stored in the pem.agent table of the pem database. You must replace the certificate and key files with the certificate or key files that corresponds to the agent's identifier.
19+
Each agent has a unique identifier that's stored in the pem.agent table of the `pem` database. You must replace the certificate and key files with the certificate or key files that correspond to the agent's identifier.
2020

2121
Prerequisites:
2222
- PEM server has certificates.
@@ -66,9 +66,9 @@ To generate a PEM agent certificate and key file pair:
6666

6767
Where `-req` indicates the input is a CSR. The `-CA` and `-CAkey` options specify the root certificate and private key to use for signing the CSR.
6868

69-
Before generating the next certificate and key file pair, move the `agent.key` and `agent.crt` files generated in the steps 2 and 4 on their respective PEM agent host.
69+
Before generating the next certificate and key-file pair, move the `agent.key` and `agent.crt` files generated in steps 2 and 4 on their respective PEM agent host.
7070

71-
6. Change the permission on the new `agent<ID>.crt` and `agent<ID>.key` file:
71+
6. Change the permission on the new `agent<ID>.crt` and `agent<ID>.key` files:
7272

7373
```shell
7474
chmod 600 agent<ID>.crt agent<ID>.key

product_docs/docs/pem/10/certificates/replacing_ssl_certificates.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ redirects:
88
If the PEM backend database server certificates are near expiring, plan to regenerate the certificates and key files.
99

1010
!!! Important
11-
By default, these steps are performed automatically when the certificates are nearing expiry.
12-
These instructions are provided for completeness if incase you need to manually regenerate the PEM certificates and keys.
11+
PEM performs these steps by default when the certificates are nearing expiry.
12+
These instructions are provided for completeness in case you need to manually regenerate the PEM certificates and keys.
1313
!!!
1414

1515
To replace the SSL certificates:
@@ -91,7 +91,7 @@ To replace the SSL certificates:
9191
openssl genrsa -out server.key 4096
9292
```
9393

94-
1. Move the `server.key` to the data directory of the backend server, and change the ownership and permissions:
94+
1. Move `server.key` to the data directory of the backend server, and change the ownership and permissions:
9595

9696
```shell
9797
mv server.key /var/lib/edb/as<x>/data
@@ -105,9 +105,9 @@ To replace the SSL certificates:
105105
openssl req -new -key server.key -out server.csr -subj '/C=IN/ST=MH/L=Pune/O=EDB/CN=PEM'
106106
```
107107

108-
Where `-subj` is provided as per your requirements. You define `CN` asthe hostname/domain name of the PEM server host.
108+
Where `-subj` is provided as per your requirements. You define `CN` as the hostname/domain name of the PEM server host.
109109

110-
1. Use the `openssl x509` command to sign the CSR and generate a server certificate. Move the `server.crt` to the data directory of the backend database server:
110+
1. Use the `openssl x509` command to sign the CSR and generate a server certificate. Move `server.crt` to the data directory of the backend database server:
111111

112112
```shell
113113
openssl x509 -req -days 365 -in server.csr -CA ca_certificate.crt -CAkey ca_key.key -CAcreateserial -out server.crt
@@ -132,4 +132,3 @@ To replace the SSL certificates:
132132
Restarting the backend database server restarts the PEM server.
133133

134134
1. Regenerate each PEM agent's SSL certificates. For more information, see [Regenerating agent SSL certificates](regenerating_agent_certificates).
135-

product_docs/docs/pem/10/changing_default_port.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Changing the default port"
33
---
44

5-
By default, the 8443 port is assigned for the web services at the time of configuration of the PEM server.
5+
By default, the 8443 port is assigned for the web services when the PEM server is configured.
66
You can change the port after configuration by changing a few parameters in the web server configuration files.
77
The names and locations of these files are platform specific.
88

product_docs/docs/pem/10/considerations/authentication_options/configuring_2fa_authentication.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ redirects:
88

99
---
1010

11-
PEM supports two methods for 2FA:
11+
PEM supports two methods for two-factor authentication (2FA):
1212

1313
- Email authentication
1414
- Authenticator app (such as Google Authenticator)
@@ -17,7 +17,7 @@ To enable 2FA, you can copy these settings from the `config.py` file to the `con
1717

1818
| Parameter | Description |
1919
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20-
| MFA_ENABLED | Set to `true` to enable the two-factor authentication. Default value is `false`. |
20+
| MFA_ENABLED | Set to `true` to enable two-factor authentication. Default value is `false`. |
2121
| MFA_FORCE_REGISTRATION | Set to `true` to ask the users to register forcefully for the two-factor authentication methods at login. Default value is `false`. |
2222
| MFA_SUPPORTED_METHODS | Set to `email` to use the email authentication method (send a one-time code by email) or `authenticator` to use the TOTP-based application authentication method. |
2323
| MFA_EMAIL_SUBJECT | Set to the subject of the email for email authentication. Default value is `<APP_NAME> - Verification Code`. |
@@ -28,7 +28,7 @@ To use the email authentication method, you need to configure mail server settin
2828

2929
PEM server can send an email using either the SMTP configurations saved in the PEM configuration or using Flask-Mail.
3030

31-
To send the email verification code using the internal SMTP configuration from the PEM configuration, set the parameter `MAIL_USE_PEM_INTERNAL` to `True`. If set to `False`, the following mail configuration is used to send the code on the user-specified email address:
31+
To send the email verification code using the internal SMTP configuration from the PEM configuration, set the parameter `MAIL_USE_PEM_INTERNAL` to `True`. If set to `False`, the following mail configuration is used to send the code to the user-specified email address:
3232

3333
- MAIL_SERVER = 'localhost'
3434
- MAIL_PORT = 25

product_docs/docs/pem/10/considerations/authentication_options/configuring_the_pem_server_to_use_kerberos_authentication.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ You can configure Kerberos authentication for the PEM server. The Kerberos serve
1313
- PEM server (PEM web server and PEM backend database server)
1414
- Client machine
1515

16-
For example, if the realm on Kerberos server is `edbpem.org`, then you can set the Kerberos server hostname to `Krb5server.edbpem.org`, the PEM server hostname to `pem.edbpem.org`, and the client's hostname to `pg12.edbpem.org`.The convention is to use the DNS domain name as the name of the realm.
16+
For example, if the realm on Kerberos server is `edbpem.org`, then you can set the Kerberos server hostname to `Krb5server.edbpem.org`, the PEM server hostname to `pem.edbpem.org`, and the client's hostname to `pg12.edbpem.org`. The convention is to use the DNS domain name as the name of the realm.
1717

1818
## 1. Install Kerberos, the PEM server, and the PEM backend database
1919

20-
Install Kerberos on the machine that functions as the authentication server. Install the PEM server on a separate machine. For more information, see [Installing the PEM Server](../../installing/).
20+
Install Kerberos on the machine that functions as the authentication server. Install the PEM server on a separate machine. For more information, see [Installing the PEM server](../../installing/).
2121

22-
Install the PEM backend database (Postgres/EDB Postgres Advanced Server) on the same machine as the PEM server or on a different one. For more information, see the Installation steps on [EDB Docs website](https://www.enterprisedb.com/docs).
22+
Install the PEM backend database (Postgres/EDB Postgres Advanced Server) on the same machine as the PEM server or on a different one. For more information, see the installation steps on [EDB Docs website](https://www.enterprisedb.com/docs).
2323

2424
## 2. Add principals on Kerberos server
2525

26-
Add the principals for the PEM web application deployed under an Apache web server (HTTPD/Apache2) and the PEM Backend Database Server (PostgreSQL/EDB Postgres Advanced Server).
26+
Add the principals for the PEM web application deployed under an Apache web server (HTTPD/Apache2) and the PEM backend database server (PostgreSQL/EDB Postgres Advanced Server).
2727

2828
```shell
2929
$ sudo kadmin.local -q "addprinc -randkey HTTP/<HOSTNAME_OF_PEM_SERVER>"
@@ -109,7 +109,7 @@ Restart the database server to reflect the changes:
109109
systemctl restart <POSTGRES_SERVICE_NAME>
110110
```
111111

112-
`POSTGRES_SERVICE_NAME` is the service name of the Postgres (PostgreSQL/EDB Postgres Advanced Server) database, for example, `postgresql-13` for PostgreSQL 13 database on a `RHEL` or Rocky Linux platforms.
112+
`POSTGRES_SERVICE_NAME` is the service name of the Postgres (PostgreSQL/EDB Postgres Advanced Server) database, for example, `postgresql-13` for PostgreSQL 13 database on a `RHEL` or Rocky Linux platform.
113113

114114
## 5. Obtain and view the initial ticket
115115

@@ -125,10 +125,10 @@ $ kinit <USERNAME@REALM>
125125
$ klist
126126
```
127127

128-
It displays the principal along with the Kerberos ticket.
128+
These commands display the principal along with the Kerberos ticket.
129129

130130
!!! Note
131-
The `USERNAME@REALM` specified here must be a database user having the pem_admin role and CONNECT privilege on `pem` database.
131+
The `USERNAME@REALM` specified here must be a database user having the pem_admin role and CONNECT privilege on the `pem` database.
132132

133133
## 6. Configure the PEM server
134134

@@ -158,13 +158,13 @@ If the PEM server uses Kerberos authentication:
158158

159159
- All the authenticated user principals are appended with the realm (USERNAME@REALM) and passed as the database user name by default. To override the default, in the `config_local.py` file, add the parameter `PEM_USER_KRB_INCLUDE_REALM` and set it to `False`.
160160

161-
- Restart the Apache server
161+
- Restart the Apache server:
162162

163163
```shell
164164
sudo systemctl restart <SERVICE_NAME>
165165
```
166166

167-
- Edit the entries at the top of `pg_hba.conf` to use the gss authentication method, and reload the database server.
167+
- Edit the entries at the top of `pg_hba.conf` to use the gss authentication method, and reload the database server:
168168

169169
```shell
170170
host pem +pem_user <ip_of_pem_server>/32 gss
@@ -178,25 +178,25 @@ If the PEM server uses Kerberos authentication:
178178
`POSTGRES_SERVICE_NAME` is the service name of the Postgres (PostgreSQL/EDB Postgres Advanced Server) database, for example, `postgresql-13` for PostgreSQL 13 database on a `RHEL` or Rocky Linux platforms.
179179

180180
!!! Note
181-
If you're using PostgreSQL or EDB Postgres Advanced Server 12 or later, then you can specify connection type as `hostgssenc` to allow only gss-encrypted connection.
181+
If you're using PostgreSQL or EDB Postgres Advanced Server 12 or later, you can specify the connection type as `hostgssenc` to allow only gss-encrypted connections.
182182

183183

184184
## 7. Browser settings
185185

186-
Configure the browser on the client machine to access the PEM web client to use the Spnego/Kerberos.
186+
Configure the browser on the client machine to access the PEM web client to use Spnego/Kerberos.
187187

188188
For Mozilla Firefox:
189189

190190
1. Open the low-level Firefox configuration page by loading the `about:config` page.
191191
1. In the search box, enter `network.negotiate-auth.trusted-uris`.
192-
1. Double-click the `network.negotiate-auth.trusted-uris` preference and enter the hostname or the domain of the web server that's protected by Kerberos HTTP SPNEGO. Separate multiple domains and hostnames with a comma.
192+
1. Double-click the `network.negotiate-auth.trusted-uris` preference and enter the hostname or the domain of the web server that's protected by Kerberos HTTP SPNEGO. Separate multiple domains and hostnames with commas.
193193
1. In the search box, enter `network.negotiate-auth.delegation-uris`.
194-
1. Double-click the `network.negotiate-auth.delegation-uris` preference and enter the hostname or the domain of the web server that's protected by Kerberos HTTP SPNEGO. Separate multiple domains and hostnames with a comma.
194+
1. Double-click the `network.negotiate-auth.delegation-uris` preference and enter the hostname or the domain of the web server that's protected by Kerberos HTTP SPNEGO. Separate multiple domains and hostnames with commas.
195195
1. Select **OK**.
196196

197197
For Google Chrome on Linux or MacOS:
198198

199-
- Add the `--auth-server-whitelist` parameter to the `google-chrome` command. For example, to run Chrome from a Linux prompt, run the `google-chrome` command as follows:
199+
- Add the `--auth-server-whitelist` parameter to the `google-chrome` command. For example, to run Chrome from a Linux prompt, use this `google-chrome` command:
200200

201201
```ini
202202
google-chrome --auth-server-whitelist = "hostname/domain"
@@ -215,4 +215,4 @@ For Google Chrome on Linux or MacOS:
215215
`psql: GSSAPI continuation error: Unspecified GSS failure. Minor code may provide more information`
216216
`GSSAPI continuation error: Key version is not available`
217217

218-
Add encryption types to the keytab using ktutil or by recreating the Postgres keytab with all crypto systems from AD.
218+
Add encryption types to the keytab using ktutil or by re-creating the Postgres keytab with all crypto systems from AD.

product_docs/docs/pem/10/considerations/authentication_options/configuring_the_pem_server_to_use_windows_kerberos_server.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ redirects:
55
- /pem/latest/pem_inst_guide_linux/04_installing_postgres_enterprise_manager/07_configuring_the_pem_server_to_use_windows_kerberos_server/
66
---
77

8-
The Windows Active Directory domain service works with hostnames and not with IP addresses. To use single sign-on in PEM Server using Active Directory domain services, configure the following machines with hostnames using the DNS:
8+
The Windows Active Directory domain service works with hostnames and not with IP addresses. To use single sign-on in PEM server using Active Directory domain services, configure the following machines with hostnames using the DNS:
99

1010
- Windows server (domain controller)
1111
- PEM server (PEM web server and PEM backend database server)
@@ -33,15 +33,15 @@ Create users in Active Directory of the Windows server to map with the HTTP serv
3333

3434
1. Enter the user details.
3535

36-
1. Give the password and make sure to clear **User must change password at next logon**. Also select **User cannot change password** and **Password never expires**.
36+
1. Enter the password and make sure to clear **User must change password at next logon**. Also select **User cannot change password** and **Password never expires**.
3737

3838
1. Review the user details.
3939

4040
1. On the PEMServer Web Properties dialog box, add the users as members of the Domain Users group:
4141

4242
![PEM Server Web Properties](../../images/pem_server_web_properties_member_of.png)
4343

44-
1. Create the user (for example, pemserverdb) in Active Cirectory of the Windows server to map with the Postgres service principal for the PEM backend database.
44+
1. Create the user (for example, pemserverdb) in Active Directory on the Windows server to map with the Postgres service principal for the PEM backend database.
4545

4646
## 3. Extract key tables from Active Directory
4747

@@ -98,7 +98,7 @@ Extract the key tables for the service principals and map them with the respecti
9898

9999
## 4. Configure the PEM backend database server
100100

101-
Add the key table location in the `postgresql.conf` file.
101+
Add the key table location in the `postgresql.conf` file:
102102

103103
```shell
104104
krb_server_keyfile='FILE:/<DATA_DIRECTORY_OF_POSTGRES>/pemdb.keytab'
@@ -147,7 +147,7 @@ $ kinit <USERNAME@REALM>
147147
$ klist
148148
```
149149

150-
It displays the principal along with the Kerberos ticket.
150+
These commands display the principal along with the Kerberos ticket.
151151

152152
!!! Note
153153
The `USERNAME@REALM` specified here must be a database user having the pem_admin role and CONNECT privileges on the `pem` database.
@@ -160,14 +160,14 @@ Run the PEM configure script on the PEM server to use Kerberos authentication:
160160
$ sudo PEM_APP_HOST=pem.edbpem.internal PEM_KRB_KTNAME=<PEM_INSTALLATION_DIRECTORY/share/pemserver.keytab <PEM_INSTALLATION_DIRECTORY>/bin/configure-pem-server.sh
161161
```
162162

163-
In the `config_setup.py` file, configure `PEM_DB_HOST` and check that the value of `PEM_AUTH_METHOD` is set to `'kerberos'`.
163+
In the `config_setup.py` file, configure `PEM_DB_HOST` and check that the value of `PEM_AUTH_METHOD` is set to `'kerberos'`:
164164

165165
```shell
166166
$ sudo vim <PEM_INSTALLATION_DIRECTORY>/share/web/config_setup.py
167167
PEM_DB_HOST=`pem.edbpem.internal`
168168
```
169169

170-
Configure `HOST` in the `.install-config` file.
170+
Configure `HOST` in the `.install-config` file:
171171

172172
```shell
173173
$ sudo vim <PEM_INSTALLATION_DIRECTORY>/share/.install-config
@@ -186,7 +186,7 @@ Restart the Apache server:
186186
sudo systemctl restart <SERVICE_NAME>
187187
```
188188

189-
Edit the entries at the top in `pg_hba.conf` to use the gss authentication method. Then reload the database server.
189+
Edit the entries at the top in `pg_hba.conf` to use the gss authentication method. Then reload the database server:
190190

191191
```shell
192192
host pem +pem_user <ip_of_pem_server>/32 gss
@@ -200,11 +200,11 @@ Edit the entries at the top in `pg_hba.conf` to use the gss authentication metho
200200
`POSTGRES_SERVICE_NAME` is the service name of the Postgres (PostgreSQL/EDB Postgres Advanced Server) database, for example, `postgresql-13` for PostgreSQL 13 database on RHEL or Rocky Linux platforms.
201201

202202
!!! Note
203-
You can't specify the connection type as `hostgssenc`. Windows doesn't support gss encrypted connection.
203+
You can't specify the connection type as `hostgssenc`. Windows doesn't support gss-encrypted connections.
204204

205205
## 7. Browser settings
206206

207-
Configure the browser on the client machine to access the PEM web client to use the Spnego/Kerberos.
207+
Configure the browser on the client machine to access the PEM web client to use Spnego/Kerberos.
208208

209209
For Mozilla Firefox:
210210

@@ -217,7 +217,7 @@ For Mozilla Firefox:
217217

218218
For Google Chrome on Linux or MacOS:
219219

220-
- Add the `--auth-server-whitelist` parameter to the `google-chrome` command. For example, to run Chrome from a Linux prompt, run the `google-chrome` command as follows:
220+
- Add the `--auth-server-whitelist` parameter to the `google-chrome` command. For example, to run Chrome from a Linux prompt, use this `google-chrome` command:
221221

222222
```ini
223223
google-chrome --auth-server-whitelist = "hostname/domain"
@@ -236,4 +236,4 @@ For Google Chrome on Linux or MacOS:
236236
`psql: GSSAPI continuation error: Unspecified GSS failure. Minor code may provide more information`
237237
`GSSAPI continuation error: Key version is not available`
238238

239-
Add encryption types to the keytab using ktutil or by recreating the Postgres keytab with all crypto systems from AD.
239+
Add encryption types to the keytab using ktutil or by re-creating the Postgres keytab with all crypto systems from AD.

product_docs/docs/pem/10/considerations/authentication_options/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ navigation:
99

1010
---
1111

12-
PEM also supports Kerberos and 2FA authentication. For implementation instructions, see:
12+
PEM supports Kerberos and two-factor authentication. For implementation instructions, see:
1313

1414
On Linux:
1515

0 commit comments

Comments
 (0)