Skip to content

Commit 7dfe6de

Browse files
mjangmjang
authored
From merged internal changes, Jan 3 1pm pacific time (#44)
### Proposed changes Merging previously approved internal changes. Here's where the changes appear: - Warnings when using install-nim-bundle script: - New section in: https://docs.nginx.com/nginx-instance-manager/deploy/vm-bare-metal/install/ - New info in: https://docs.nginx.com/nginx-instance-manager/disconnected/offline-install-guide/ - Anonymized PII, various locations Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide specific feedback, add them here. If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here: Closes #ISSUE ### Checklist Before creating a PR, run through this checklist and mark each as complete. - [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) - [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) - [ ] If applicable, I have added tests that prove my fix is effective or that my feature works - [ ] If applicable, I have checked that any relevant tests pass after adding my changes - [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) - [ ] I have rebased my branch onto main - [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork - [ ] If the change involves: - Code - Anything that resembles Personally identifying information (PII) - Make sure to use placeholders such as `<username>` in place of PII - URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0)) - Significant new/revised content In these cases, the change will require at least two (2) approvals before merging
2 parents 870723d + d6715b6 commit 7dfe6de

File tree

14 files changed

+67
-62
lines changed

14 files changed

+67
-62
lines changed

‎content/controller/admin-guides/install/try-nginx-controller.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ For example:
216216
- Login and capture the session cookie:
217217

218218
```curl
219-
curl -c cookie.txt -X POST --url 'https://198.51.100.10/api/v1/platform/login' --header 'Content-Type: application/json' --data '{"credentials": {"type": "BASIC","username": "arthur@arthurdent.net","password": "Towel$123"}}'
219+
curl -c cookie.txt -X POST --url 'https://198.51.100.10/api/v1/platform/login' --header 'Content-Type: application/json' --data '{"credentials": {"type": "BASIC","username": "arthur@example.net","password": "<password>"}}'
220220
```
221221

222222
- Use the session cookie to authenticate and get the session status:

‎content/controller/admin-guides/install/using-helper-script.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Use the `helper.sh` script to change the SMTP address; port; TLS; sender; and op
183183
For example:
184184

185185
``` bash
186-
/opt/nginx-controller/helper.sh configsmtp 192.0.2.0 25 false [email protected] true user1 password1
186+
/opt/nginx-controller/helper.sh configsmtp 192.0.2.0 25 false [email protected] true user1 <password>
187187
```
188188

189189
<style>
@@ -234,7 +234,7 @@ CTR_SMTP_HOST=192.0.2.0 \
234234
CTR_SMTP_PORT=25 \
235235
CTR_SMTP_TLS=false \
236236
[email protected] \
237-
CTR_SMTP_AUTH=true CTR_SMTP_USER=user1 CTR_SMTP_PASS=password1 \
237+
CTR_SMTP_AUTH=true CTR_SMTP_USER=user1 CTR_SMTP_PASS=<password> \
238238
/opt/nginx-controller/helper.sh configsmtp
239239
```
240240

@@ -253,7 +253,7 @@ Use the `helper.sh` script to change the external config database address; port;
253253
For example:
254254

255255
``` bash
256-
/opt/nginx-controller/helper.sh configdb 192.0.2.1 5432 user1 password1 false
256+
/opt/nginx-controller/helper.sh configdb 192.0.2.1 5432 user1 <password> false
257257
```
258258

259259
<style>
@@ -305,7 +305,7 @@ For example:
305305
CTR_DB_HOST=192.0.2.1 \
306306
CTR_DB_PORT=5432 \
307307
CTR_DB_USER=user1 \
308-
CTR_DB_PASS=password1 \
308+
CTR_DB_PASS=<password> \
309309
CTR_DB_ENABLE_SSL=false \
310310
/opt/nginx-controller/helper.sh configdb
311311
```

‎content/controller/api/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ For example:
7676
- Login and capture the session cookie:
7777

7878
```curl
79-
curl -c cookie.txt -X POST --url 'https://198.51.100.10/api/v1/platform/login' --header 'Content-Type: application/json' --data '{"credentials": {"type": "BASIC","username": "arthur@arthurdent.net","password": "Towel$123"}}'
79+
curl -c cookie.txt -X POST --url 'https://198.51.100.10/api/v1/platform/login' --header 'Content-Type: application/json' --data '{"credentials": {"type": "BASIC","username": "arthur@example.net","password": "<password>"}}'
8080
```
8181

8282
- Use the session cookie to authenticate and get the session status:

‎content/controller/api/reference/ctlr-adc-openapi.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11369,15 +11369,15 @@
1136911369
"type": "AWS_INTEGRATION",
1137011370
"credential": {
1137111371
"type": "AWS_ACCESS_KEY_CREDENTIAL",
11372-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
11372+
"accessKeyID": "<access key id>",
1137311373
"secretAccessKey": "*********"
1137411374
}
1137511375
},
1137611376
"currentStatus": {
1137711377
"type": "AWS_INTEGRATION",
1137811378
"credential": {
1137911379
"type": "AWS_ACCESS_KEY_CREDENTIAL",
11380-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
11380+
"accessKeyID": "<access key id>",
1138111381
"secretAccessKey": "*********"
1138211382
}
1138311383
}
@@ -11665,7 +11665,7 @@
1166511665
"desiredState": {
1166611666
"credential": {
1166711667
"type": "API_KEY",
11668-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
11668+
"apiKey": "<access key id>"
1166911669
}
1167011670
}
1167111671
}
@@ -11689,7 +11689,7 @@
1168911689
"desiredState": {
1169011690
"credential": {
1169111691
"type": "API_KEY",
11692-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
11692+
"apiKey": "<access key id>"
1169311693
}
1169411694
}
1169511695
}
@@ -11707,7 +11707,7 @@
1170711707
"desiredState": {
1170811708
"credential": {
1170911709
"type": "API_KEY",
11710-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
11710+
"apiKey": "<access key id>"
1171111711
}
1171211712
}
1171311713
}

‎content/controller/api/reference/ctlr-apim-openapi.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10634,15 +10634,15 @@
1063410634
"type": "AWS_INTEGRATION",
1063510635
"credential": {
1063610636
"type": "AWS_ACCESS_KEY_CREDENTIAL",
10637-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
10637+
"accessKeyID": "<access key id>",
1063810638
"secretAccessKey": "*********"
1063910639
}
1064010640
},
1064110641
"currentStatus": {
1064210642
"type": "AWS_INTEGRATION",
1064310643
"credential": {
1064410644
"type": "AWS_ACCESS_KEY_CREDENTIAL",
10645-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
10645+
"accessKeyID": "<access key id>",
1064610646
"secretAccessKey": "*********"
1064710647
}
1064810648
}
@@ -12013,7 +12013,7 @@
1201312013
"desiredState": {
1201412014
"credential": {
1201512015
"type": "API_KEY",
12016-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
12016+
"apiKey": "<access key id>"
1201712017
}
1201812018
}
1201912019
}
@@ -12037,7 +12037,7 @@
1203712037
"desiredState": {
1203812038
"credential": {
1203912039
"type": "API_KEY",
12040-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
12040+
"apiKey": "<access key id>"
1204112041
}
1204212042
}
1204312043
}
@@ -12055,7 +12055,7 @@
1205512055
"desiredState": {
1205612056
"credential": {
1205712057
"type": "API_KEY",
12058-
"apiKey": "ADv2ZheQnLjVx5klhQ39"
12058+
"apiKey": "<access key id>"
1205912059
}
1206012060
}
1206112061
}

‎content/controller/api/reference/ctlr-platform-openapi.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -905,8 +905,8 @@
905905
"userFormat": "UPN",
906906
"bindUser": {
907907
"type": "PASSWORD",
908-
"username": "user@mydomain",
909-
"password": "passwd1234"
908+
"username": "<username>",
909+
"password": "<password>"
910910
},
911911
"pollIntervalSec": 3600,
912912
"groupCacheTimeSec": 7200,
@@ -7147,7 +7147,7 @@
71477147
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
71487148
"credential": {
71497149
"type": "AWS_ACCESS_KEY",
7150-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7150+
"accessKeyID": "<access key id>",
71517151
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)"
71527152
}
71537153
}
@@ -7171,7 +7171,7 @@
71717171
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
71727172
"credential": {
71737173
"type": "AWS_ACCESS_KEY",
7174-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7174+
"accessKeyID": "<access key id>",
71757175
"secretAccessKey": "*********"
71767176
}
71777177
},
@@ -7180,7 +7180,7 @@
71807180
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
71817181
"credential": {
71827182
"type": "AWS_ACCESS_KEY",
7183-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7183+
"accessKeyID": "<access key id>",
71847184
"secretAccessKey": "*********"
71857185
}
71867186
}
@@ -7254,7 +7254,7 @@
72547254
"type": "AWS_INTEGRATION",
72557255
"credential": {
72567256
"type": "AWS_ACCESS_KEY",
7257-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7257+
"accessKeyID": "<access key id>",
72587258
"secretAccessKey": "*********"
72597259
}
72607260
}
@@ -7278,7 +7278,7 @@
72787278
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
72797279
"credential": {
72807280
"type": "AWS_ACCESS_KEY",
7281-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7281+
"accessKeyID": "<access key id>",
72827282
"secretAccessKey": "*********"
72837283
}
72847284
},
@@ -7287,7 +7287,7 @@
72877287
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
72887288
"credential": {
72897289
"type": "AWS_ACCESS_KEY",
7290-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7290+
"accessKeyID": "<access key id>",
72917291
"secretAccessKey": "*********"
72927292
}
72937293
}
@@ -7366,7 +7366,7 @@
73667366
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
73677367
"credential": {
73687368
"type": "AWS_ACCESS_KEY",
7369-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7369+
"accessKeyID": "<access key id>",
73707370
"secretAccessKey": "*********"
73717371
}
73727372
},
@@ -7375,7 +7375,7 @@
73757375
"endpointUri": "https://ec2.us-west-1.amazonaws.com",
73767376
"credential": {
73777377
"type": "AWS_ACCESS_KEY",
7378-
"accessKeyID": "AKIAJ3N2PZUMZE3Y67ZA",
7378+
"accessKeyID": "<access key id>",
73797379
"secretAccessKey": "*********"
73807380
}
73817381
}

‎content/nap-waf/v5/admin-guide/compiler.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ For instance:
136136
{
137137
"waf-settings": {
138138
"cookie-protection": {
139-
"seed": "80miIOiSeXfvNBiDJV4t"
139+
"seed": "<seed value>"
140140
}
141141
}
142142
}

‎content/nginx/deployment-guides/single-sign-on/keycloak.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Configure NGINX Plus as the OpenID Connect relying party:
131131
- `map $host $oidc_authz_endpoint` – Value of `authorization_endpoint` from [Step 3](#nginx-plus-urls) (in this guide, <span style="white-space: nowrap;">`https://<keycloak-server-address>/auth/realms/master/protocol/openid-connect/auth`</span>)
132132
- `map $host $oidc_token_endpoint` – Value of `token_endpoint` from [Step 3](#nginx-plus-urls) (in this guide, <span style="white-space: nowrap;">`https://<keycloak-server-address>/auth/realms/master/protocol/openid-connect/token`)</span>
133133
- `map $host $oidc_client` – Value in the **Client ID** field from [Step 3 of _Configuring Keycloak_](#keycloak-client-id) (in this guide, `NGINX Plus`)
134-
- `map $host $oidc_client_secret` – Value in the **Secret** field from [Step 5 of _Configuring Keycloak_](#keycloak-secret) (in this guide, <span style="white-space: nowrap;">`w4b32c4b0-f4b3-41d9-a345-2bc0fbfcaaba`)</span>
134+
- `map $host $oidc_client_secret` – Value in the **Secret** field from [Step 5 of _Configuring Keycloak_](#keycloak-secret) (in this guide, <span style="white-space: nowrap;">`<oidc client secret>`)</span>
135135
- `map $host $oidc_hmac_key` – A unique, long, and secure phrase
136136

137137
5. Configure the JWK file. The procedure depends on which version of NGINX Plus you are using.

‎content/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To change a user's password with the `basic_passwords.sh` script:
8080
For example:
8181

8282
```bash
83-
sudo bash /etc/nms/scripts/basic_passwords.sh johndoe 'jelly22fi$h'
83+
sudo bash /etc/nms/scripts/basic_passwords.sh johndoe '<password>'
8484
```
8585

8686
### Manually set user passwords {#manually-set-basic-passwords}

‎content/nim/deploy/vm-bare-metal/install.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ Download the certificate and private key required for NGINX Instance Manager. Th
9696

9797
## Download and run the installation script {#download-install}
9898

99+
Download the `install-nim-bundle.sh` script:
100+
101+
{{<fa "download">}} {{<link "/scripts/install-nim-bundle.sh" "Download install-nim-bundle.sh script">}}
102+
99103
### Prepare your system for installation
100104

101105
Follow these steps to get your system ready for a successful installation with the `install-nim-bundle.sh` script:
@@ -135,10 +139,6 @@ As noted in [About subscription licenses]({{< relref "solutions/about-subscripti
135139
136140
{{< /warning >}}
137141
138-
Download the `install-nim-bundle.sh` script:
139-
140-
{{<fa "download">}} {{<link "/scripts/install-nim-bundle.sh" "Download install-nim-bundle.sh script">}}
141-
142142
When you run the script, it downloads and installs NGINX Instance Manager.
143143
144144
If you want to use the script with non-default options, use these switches:
@@ -193,6 +193,16 @@ After installation, you can access the NGINX Instance Manager web interface to b
193193
194194
Save the autogenerated password displayed at the end of the installation process. If you want to change the admin password, refer to the [Set user passwords]({{< relref "/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md#set-basic-passwords" >}}) section in the Basic Authentication topic.
195195
196+
197+
### Using the script to uninstall NGINX Instance Manager and its dependencies
198+
199+
In some cases, the script may need to be re-run due to parameters not being set correctly, or wrong versions being specified. You can remove NGINX Instance Manager and all of its dependencies (including NGINX) so that the script can be re-run.
200+
201+
{{<call-out "warning" "Potential for data loss" "">}}The `-r` option removes all NGINX configuration files, NGINX Instance Manager, and ClickHouse. Once you run this command, the data is gone and cannot be recovered unless you have backups. Use this option only if you need to remove NGINX Instance Manager to re-run the script in a fresh environment for a new installation. See "[Uninstall NGINX Instance Manager](#uninstall-nim)" below to perform these steps manually. If you do not want to lose your NGINX Configuration, you should take a backup of `/etc/nginx/`. {{</call-out>}}
202+
203+
```bash
204+
bash install-nim-bundle.sh -r
205+
```
196206
---
197207
198208
## Post-installation steps

0 commit comments

Comments
 (0)