You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,10 @@
22
22
23
23
Before sharing this pull request, I completed the following checklist:
24
24
25
-
-[ ] I read the [Contributing guidelines](/CONTRIBUTING.md)
26
-
-[ ] My branch adheres to the [Git conventions](/documentation/git-conventions.md)
27
-
-[ ] My content changes adhere to the [F5 NGINX Documentation style guide](/documentation/style-guide.md)
25
+
-[ ] I read the [Contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
26
+
-[ ] My branch adheres to the [Git conventions](https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md)
27
+
-[ ] My content changes adhere to the [F5 NGINX Documentation style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md)
28
28
-[ ] If my changes involve potentially sensitive information[^1], I have assessed the possible impact
29
29
-[ ] I have waited to ensure my changes pass tests, and addressed any discovered issues
30
30
31
-
[^1]: Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the [style guide](/documentation/style-guide.md) for guidance about placeholder content.
31
+
[^1]: Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the [style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md) for guidance about placeholder content.
@@ -218,7 +218,7 @@ If you are upgrading from an older version, update your configuration accordingl
218
218
219
219
<br>
220
220
221
-
{{<note>}}
221
+
{{< call-out "note" >}}
222
222
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
223
223
224
224
NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
@@ -227,15 +227,15 @@ NGINX Agent follows NGINX configuration directives to file paths outside the des
{{<note>}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
232
+
{{< call-out "note" >}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
233
233
234
234
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
235
235
236
236
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
Copy file name to clipboardExpand all lines: content/agent/configuration/encrypt-communication.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ NGINX_AGENT_TLS_ENABLE=true
94
94
95
95
## Enable Server-Side TLS With Self-Signed Certificate
96
96
97
-
{{< warning >}}These steps are not recommended for production environments.{{< /warning >}}
97
+
{{< call-out "warning" >}}These steps are not recommended for production environments.{{< /call-out >}}
98
98
99
99
To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example:
Copy file name to clipboardExpand all lines: content/agent/installation-upgrade/container-environments/docker-images.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ This guide provides instructions on how to build images with NGINX Agent and NGI
27
27
28
28
You can use [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) to manage NGINX Agent container images. Follow the installation instructions for your preferred container engine and be sure the service is running before proceeding with the instructions in this document.
29
29
30
-
{{<note>}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{</note>}}
30
+
{{< call-out "note" >}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{< /call-out >}}
31
31
32
32
### Install the GNU Make package
33
33
@@ -112,7 +112,7 @@ docker tag docker-registry.nginx.com/nginx/agent:mainline nginx-agent
112
112
docker run --name nginx-agent -d nginx-agent
113
113
```
114
114
115
-
{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview">}}).{{</note>}}
115
+
{{< call-out "note">}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview">}}).{{< /call-out >}}
116
116
117
117
### Enable the gRPC interface
118
118
@@ -166,7 +166,7 @@ If the REST Interface is configured correctly, then you should see a JSON object
166
166
167
167
## Build the NGINX Agent images for specific OS targets
168
168
169
-
{{<important>}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{</important>}}
169
+
{{< call-out "important" >}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{< /call-out >}}
170
170
171
171
The NGINX Agent GitHub repo has a set of Make commands that you can use to build a container image for an specific operating system and version:
{{<important>}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{</important>}}
203
+
{{< call-out "important" >}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{< /call-out >}}
204
204
205
205
Run the following `make` command to build the default image, which uses Ubuntu 24.04 (Noble) as the base image.
NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`.
174
174
175
-
{{< important >}}
175
+
{{< call-out "important" >}}
176
176
Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.
177
177
178
178
For more information, see [NGINX Agent Log Rotation]({{< ref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
Copy file name to clipboardExpand all lines: content/agent/installation-upgrade/installation-unprivileged.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,9 @@ The installation process involves installing NGINX Plus without root privileges
30
30
31
31
You can install NGINX Plus without root privileges following the steps on the [NGINX Plus installation page]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus/#unpriv_install" >}}). The steps include a script that will allow you to install NGINX Plus in a non-root environment.
32
32
33
-
{{< note >}}
33
+
{{< call-out "note" >}}
34
34
NGINX Agent has its own user group (`nginx-agent`) which is created when NGINX Agent is installed. The user NGINX is running under is added to this user group during the installation of NGINX Agent. If you change the NGINX user after installing NGINX Agent, you will need to [manually add the new NGINX user]({{< ref "/agent/configuration/configure-nginx-agent-group.md" >}}) to the `nginx-agent` group.
0 commit comments