Skip to content

Commit 1b360b0

Browse files
authored
Merge pull request #5202 from BimsaraBodaragama/internal/3370
Clarify HTTP usage and NGINX configuration path in documentation
2 parents e4dadbc + 5b28b36 commit 1b360b0

8 files changed

Lines changed: 110 additions & 3 deletions

File tree

en/identity-server/5.10.0/docs/setup/fronting-with-the-nginx-load-balancer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ collectively as "Nginx".)
3232
/etc/nginx/conf.d ` directory and add the following configurations
3333
into it.
3434

35+
!!! note
36+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
37+
38+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
39+
3540
??? abstract "Click here to view a generic Nginx configuration"
3641

3742
```java tab="HTTP configuration"
@@ -133,6 +138,11 @@ collectively as "Nginx".)
133138
}
134139
```
135140

141+
!!! warning "Security Notice"
142+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
143+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
144+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
145+
136146
3. Now that you've configured HTTP requests, you must also configure
137147
HTTPS requests. Configure Nginx to direct the HTTPS requests to the
138148
two worker nodes via the HTTPS 443 port using ` https://is.wso2.com/
@@ -141,6 +151,9 @@ collectively as "Nginx".)
141151
into it.
142152

143153
!!! note
154+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
155+
156+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
144157

145158
The configurations for nginx community version and NGINX
146159
Plus are different here since the community version does not support

en/identity-server/5.11.0/docs/setup/fronting-with-the-nginx-load-balancer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ collectively as "Nginx".)
3232
/etc/nginx/conf.d ` directory and add the following configurations
3333
into it.
3434

35+
!!! note
36+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
37+
38+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
39+
3540
??? abstract "Click here to view a generic Nginx configuration"
3641

3742
```java tab="HTTP configuration"
@@ -133,6 +138,11 @@ collectively as "Nginx".)
133138
}
134139
```
135140

141+
!!! warning "Security Notice"
142+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
143+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
144+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
145+
136146
3. Now that you've configured HTTP requests, you must also configure
137147
HTTPS requests. Configure Nginx to direct the HTTPS requests to the
138148
two worker nodes via the HTTPS 443 port using ` https://is.wso2.com/
@@ -141,6 +151,9 @@ collectively as "Nginx".)
141151
into it.
142152

143153
!!! note
154+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
155+
156+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
144157

145158
The configurations for nginx community version and NGINX
146159
Plus are different here since the community version does not support

en/identity-server/5.9.0/docs/setup/fronting-with-the-nginx-load-balancer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ collectively as "Nginx".)
3232
/etc/nginx/conf.d ` directory and add the following configurations
3333
into it.
3434

35+
!!! note
36+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
37+
38+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
39+
3540
??? abstract "Click here to view a generic Nginx configuration"
3641

3742
```java tab="HTTP configuration"
@@ -133,6 +138,11 @@ collectively as "Nginx".)
133138
}
134139
```
135140

141+
!!! warning "Security Notice"
142+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
143+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
144+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
145+
136146
3. Now that you've configured HTTP requests, you must also configure
137147
HTTPS requests. Configure Nginx to direct the HTTPS requests to the
138148
two worker nodes via the HTTPS 443 port using ` https://is.wso2.com/
@@ -141,6 +151,9 @@ collectively as "Nginx".)
141151
into it.
142152

143153
!!! note
154+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
155+
156+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
144157

145158
The configurations for nginx community version and NGINX
146159
Plus are different here since the community version does not support

en/identity-server/6.0.0/docs/deploy/front-with-the-nginx-load-balancer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ collectively as "Nginx".)
3434
/etc/nginx/conf.d ` directory and add the following configurations
3535
into it.
3636

37+
!!! note
38+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
39+
40+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
41+
3742
??? abstract "Click here to view a generic Nginx configuration"
3843

3944
```java tab="HTTP configuration"
@@ -135,13 +140,21 @@ collectively as "Nginx".)
135140
}
136141
```
137142

143+
!!! warning "Security Notice"
144+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
145+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
146+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
147+
138148
3. Now that you've configured HTTP requests, you must also configure
139149
HTTPS requests. Configure Nginx to direct the HTTPS requests to the
140150
two worker nodes via the HTTPS 443 port using ` https://is.wso2.com/` . To do this, create a VHost file ( ` is.https.conf ` ) in the `
141151
/etc/nginx/conf.d ` directory and add the following configurations
142152
into it.
143153

144154
!!! note
155+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
156+
157+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
145158

146159
The configurations for nginx community version and NGINX
147160
Plus are different here since the community version does not support

en/identity-server/6.1.0/docs/deploy/front-with-the-nginx-load-balancer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ collectively as "Nginx".)
3434
/etc/nginx/conf.d ` directory and add the following configurations
3535
into it.
3636

37+
!!! note
38+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
39+
40+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
41+
3742
??? abstract "Click here to view a generic Nginx configuration"
3843

3944
```java tab="HTTP configuration"
@@ -135,13 +140,21 @@ collectively as "Nginx".)
135140
}
136141
```
137142

143+
!!! warning "Security Notice"
144+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
145+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
146+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
147+
138148
3. Now that you've configured HTTP requests, you must also configure
139149
HTTPS requests. Configure Nginx to direct the HTTPS requests to the
140150
two worker nodes via the HTTPS 443 port using ` https://is.wso2.com/` . To do this, create a VHost file ( ` is.https.conf ` ) in the `
141151
/etc/nginx/conf.d ` directory and add the following configurations
142152
into it.
143153

144154
!!! note
155+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
156+
157+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
145158

146159
The configurations for nginx community version and NGINX
147160
Plus are different here since the community version does not support

en/identity-server/7.0.0/docs/deploy/front-with-the-nginx-load-balancer.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
2222
1. Install Nginx (NGINX Plus or Nginx community) in a server configured in your cluster.
2323
2. Configure Nginx to direct the HTTP requests to the two worker nodes via the HTTP 80 port using the `http://is.wso2.com/>`. To do this, create a VHost file ( ` is.http.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
2424

25+
!!! note
26+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
27+
28+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
29+
2530
??? abstract "Click here to view a generic Nginx configuration"
2631

2732
```java
@@ -123,10 +128,19 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
123128
}
124129
```
125130

131+
!!! warning "Security Notice"
132+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
133+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
134+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
135+
126136
3. Now that you've configured HTTP requests, you must also configure HTTPS requests. Configure Nginx to direct the HTTPS requests to the two worker nodes via the HTTPS 443 port using `https://is.wso2.com/`. To do this, create a VHost file ( ` is.https.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
127137

128138
!!! note
129-
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
139+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
140+
141+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
142+
143+
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
130144

131145
=== "nginx Community Version"
132146
```

en/identity-server/7.1.0/docs/deploy/front-with-the-nginx-load-balancer.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
2222
1. Install Nginx (NGINX Plus or Nginx community) in a server configured in your cluster.
2323
2. Configure Nginx to direct the HTTP requests to the two worker nodes via the HTTP 80 port using the `http://is.wso2.com/>`. To do this, create a VHost file ( ` is.http.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
2424

25+
!!! note
26+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
27+
28+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
29+
2530
??? abstract "Click here to view a generic Nginx configuration"
2631

2732
```java
@@ -123,10 +128,19 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
123128
}
124129
```
125130

131+
!!! warning "Security Notice"
132+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
133+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
134+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
135+
126136
3. Now that you've configured HTTP requests, you must also configure HTTPS requests. Configure Nginx to direct the HTTPS requests to the two worker nodes via the HTTPS 443 port using `https://is.wso2.com/`. To do this, create a VHost file ( ` is.https.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
127137

128138
!!! note
129-
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
139+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
140+
141+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
142+
143+
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
130144

131145
=== "nginx Community Version"
132146
```

en/identity-server/next/docs/deploy/front-with-the-nginx-load-balancer.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
2222
1. Install Nginx (NGINX Plus or Nginx community) in a server configured in your cluster.
2323
2. Configure Nginx to direct the HTTP requests to the two worker nodes via the HTTP 80 port using the `http://is.wso2.com/>`. To do this, create a VHost file ( ` is.http.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
2424

25+
!!! note
26+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
27+
28+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
29+
2530
??? abstract "Click here to view a generic Nginx configuration"
2631

2732
```java
@@ -123,10 +128,19 @@ Use the following steps to configure [NGINX Plus](https://www.nginx.com/products
123128
}
124129
```
125130

131+
!!! warning "Security Notice"
132+
While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns.
133+
Instead, configure HTTPS (port 443) to ensure all communication is encrypted.
134+
If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.
135+
126136
3. Now that you've configured HTTP requests, you must also configure HTTPS requests. Configure Nginx to direct the HTTPS requests to the two worker nodes via the HTTPS 443 port using `https://is.wso2.com/`. To do this, create a VHost file ( ` is.https.conf ` ) in the `/etc/nginx/conf.d` directory and add the following configurations into it.
127137

128138
!!! note
129-
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
139+
For NGINX Open Source, the location depends on the installation method and OS. Common locations include `/usr/local/nginx/conf`, `/etc/nginx`, or `/usr/local/etc/nginx`.
140+
141+
_See [NGINX docs](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) for details._
142+
143+
The configurations for the Nginx community version and NGINX Plus are different here since the community version does not support the `sticky` directive.
130144

131145
=== "nginx Community Version"
132146
```

0 commit comments

Comments
 (0)