Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/agent/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX

- Enable Access to Key NGINX One Use Cases
- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows.
- [Connect to NGINX One Console]({{< relref "/agent/install-upgrade/install/#connect-an-instance-to-nginx-one-console" >}})
- [Connect to NGINX One Console]({{< relref "/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})

- Real-Time Observability into NGINX One Data Plane Instances
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency.
Expand Down
2 changes: 1 addition & 1 deletion content/agent/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toc: true

{{< note >}}You can find the full changelog, contributor list and assets for NGINX Agent in the [GitHub repository](https://github.com/nginx/agent/releases).{{< /note >}}

See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< relref "./technical-specifications.md" >}}).
See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< relref "./tech-specs.md" >}}).

---
## Release [v3.0.0](https//github.com/nginx/agent/releases/tag/v3.0.0)
Expand Down
4 changes: 2 additions & 2 deletions content/agent/contribute/dev-environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Ubuntu is the recommended operating system for development, as it comes with mos

To begin this task, you will require the following:

- A [working NGINX Agent instance]({{< relref "/agent/install-upgrade/install.md" >}}).
- A [working NGINX Agent instance]({{< relref "/agent/install-upgrade/" >}}).
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
- A [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/) installation.

Expand All @@ -29,7 +29,7 @@ git clone [email protected]:nginx/agent.git

Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information

Follow the steps in the [Installation]({{< relref "/agent/install-upgrade/install.md" >}}) topic to install NGINX Agent.
Follow the steps in the [Installation]({{< relref "/agent/install-upgrade/" >}}) topic to install NGINX Agent.

## Install prerequisite packages
Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.
Expand Down
2 changes: 1 addition & 1 deletion content/agent/contribute/start-mock-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The mock interface is useful when developing NGINX Agent, as it allows you to vi

To begin this task, you will require the following:

- A [working NGINX Agent instance]({{< relref "/agent/install-upgrade/install.md" >}}).
- A [working NGINX Agent instance]({{< relref "/agent/install-upgrade/" >}}).
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
- A [go-swagger](https://goswagger.io/go-swagger/install/) installation.

Expand Down
2 changes: 1 addition & 1 deletion content/agent/install-upgrade/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Install and upgrade"
title: "Install and update"
weight: 400
url: /nginx-agent/install-upgrade/
---
Expand Down
72 changes: 72 additions & 0 deletions content/agent/install-upgrade/install-from-github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Install from GitHub package files
toc: true
weight: 300
docs: DOCS-000
---

{{< note>}}
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
to manage your NGINX instances, NGINX Agent is installed automatically when you
add an NGINX instance to NGINX One Console.

For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< relref "/nginx-one/how-to/nginx-configs/add-instance" >}})
{{< /note >}}

Follow the steps in this guide to install NGINX Agent in your NGINX instance using
GitHub package files.

## Before you begin

{{< include "/agent/installation/prerequisites.md" >}}

## GitHub package files

To install NGINX Agent on your system using GitHub package files, go to the
[GitHub releases page](https://github.com/nginx/agent/releases) and download the
latest package supported by your operating system distribution and CPU architecture.

Use your system's package manager to install the package. Some examples:

- Debian, Ubuntu, and other distributions using the `dpkg` package manager.

```shell
sudo dpkg -i nginx-agent-<agent-version>.deb
```

- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using
the `yum` package manager

```shell
sudo yum localinstall nginx-agent-<agent-version>.rpm
```

- RHEL and other distributions using the `rpm` package manager

```shell
sudo rpm -i nginx-agent-<agent-version>.rpm
```

- Alpine Linux

```shell
sudo apk add nginx-agent-<agent-version>.apk
```

- FreeBSD

```shell
sudo pkg add nginx-agent-<agent-version>.pkg
```

### Manually connect NGINX Agent to NGINX One Console

{{< include "agent/installation/manually-connect-to-console" >}}

## Start, stop, and enable NGINX Agent

{{< include "/agent/installation/start-stop-agent.md" >}}

## Verify that NGINX Agent is running

{{< include "/agent/installation/verify-agent.md" >}}
103 changes: 103 additions & 0 deletions content/agent/install-upgrade/install-from-oss-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
title: Install from Open Source repo
toc: true
weight: 100
docs: DOCS-000
---

{{< note>}}
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
to manage your NGINX instances, NGINX Agent is installed automatically when you
add an NGINX instance to NGINX One Console.

For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< relref "/nginx-one/how-to/nginx-configs/add-instance" >}})
{{< /note >}}

## Overview

Follow the steps in this guide to install NGINX Agent in your NGINX instance using
the NGINX Open Source repository.

## Before you begin

{{< include "/agent/installation/prerequisites.md" >}}

## Manual installation using the NGINX Open Source repository

Before you install NGINX Agent for the first time on your system, you need to set
up the `nginx-agent` packages repository. Afterward, you can install and update
NGINX Agent from the repository.

<details>
<summary>{{< fa "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>

### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux

{{< include "/agent/installation/oss/oss-rhel.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>

### Install NGINX Agent on Ubuntu

{{< include "/agent/installation/oss/oss-ubuntu.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-debian" >}} Install NGINX Agent on Debian</summary>

### Install NGINX Agent on Debian

{{< include "/agent/installation/oss/oss-debian.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-suse" >}} Install NGINX Agent on SLES</summary>

### Install NGINX Agent on SLES

{{< include "/agent/installation/oss/oss-sles.md" >}}

</details>

<details>
<summary>{{< fa "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>

### Install NGINX Agent on Alpine Linux

{{< include "/agent/installation/oss/oss-alpine.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>

### Install NGINX Agent on Amazon Linux

{{< include "/agent/installation/oss/oss-amazon-linux.md" >}}

</details>
<details>
<summary>{{< fa "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>

### Install NGINX Agent on FreeBSD

{{< include "/agent/installation/oss/oss-freebsd.md" >}}

</details>

### Manually connect NGINX Agent to NGINX One Console

{{< include "agent/installation/manually-connect-to-console" >}}

## Start, stop, and enable NGINX Agent

{{< include "/agent/installation/start-stop-agent.md" >}}

## Verify that NGINX Agent is running

{{< include "/agent/installation/verify-agent.md" >}}
104 changes: 104 additions & 0 deletions content/agent/install-upgrade/install-from-plus-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: Install from NGINX Plus repo
toc: true
weight: 200
docs: DOCS-000
---

{{< note>}}
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
to manage your NGINX instances, NGINX Agent is installed automatically when you
add an NGINX instance to NGINX One Console.

For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< relref "/nginx-one/how-to/nginx-configs/add-instance" >}})
{{< /note >}}

## Overview

Follow the steps in this guide to install NGINX Agent in your NGINX instance using
the NGINX Plus repository.

## Before you begin

{{< include "/agent/installation/prerequisites.md" >}}

## Manual installation using the NGINX Plus repository

Before you install NGINX Agent for the first time on your system, you need to
set up the `nginx-agent` packages repository. Afterward, you can install and update
NGINX Agent from the repository.


<details>
<summary>{{< fa "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>

### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux<a name="install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux-plus"></a>

{{< include "/agent/installation/plus/plus-rhel.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>

### Install NGINX Agent on Ubuntu<a name="install-nginx-agent-on-ubuntu-plus"></a>

{{< include "/agent/installation/plus/plus-ubuntu.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-debian" >}} Install NGINX Agent on Debian</summary>

### Install NGINX Agent on Debian<a name="install-nginx-agent-on-debian-plus"></a>

{{< include "/agent/installation/plus/plus-debian.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-suse" >}} Install NGINX Agent on SLES</summary>

### Install NGINX Agent on SLES<a name="install-nginx-agent-on-sles-plus"></a>

{{< include "/agent/installation/plus/plus-sles.md" >}}

</details>

<details>
<summary>{{< fa "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>

### Install NGINX Agent on Alpine Linux<a name="install-nginx-agent-on-alpine-linux-plus"></a>

{{< include "/agent/installation/plus/plus-alpine.md" >}}

</details>
<details>
<summary>{{< fa "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>

### Install NGINX Agent on Amazon Linux<a name="install-nginx-agent-on-amazon-linux-plus"></a>

{{< include "/agent/installation/plus/plus-amazon-linux.md" >}}

</details>

<details>
<summary>{{< fa "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>

### Install NGINX Agent on FreeBSD<a name="install-nginx-agent-on-freebsd-plus"></a>

{{< include "/agent/installation/plus/plus-freebsd.md" >}}

</details>

### Manually connect NGINX Agent to NGINX One Console

{{< include "agent/installation/manually-connect-to-console" >}}

## Start, stop, and enable NGINX Agent

{{< include "/agent/installation/start-stop-agent.md" >}}

## Verify that NGINX Agent is running

{{< include "/agent/installation/verify-agent.md" >}}
Loading
Loading