Skip to content

fix: add v2 v3 docker pull steps #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 8, 2025
Merged
Show file tree
Hide file tree
Changes from 5 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
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ sudo docker login private-registry.nginx.com --username=YOUR_JWT_HERE --password

### Pull the NGINX Plus image

Pull the NGINX Plus image from the private registry. Replace `VERSION_TAG` with the desired version, such as `alpine`, `debian`, or `ubi`.
Pull the NGINX Plus image from the private registry. Replace `<version-tag>` with the desired version, such as `alpine`, `debian`, or `ubi`.

```sh
sudo docker pull private-registry.nginx.com/nginx-plus/agent:VERSION_TAG
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
```

You must specify a version tag. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
You must specify a version tag that matches your distribution. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.

<br>

Expand All @@ -62,7 +62,7 @@ sudo docker pull private-registry.nginx.com/nginx-plus/agent:debian

### Start the NGINX Plus container

Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `VERSION_TAG` with the version tag you pulled.
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `version-tag` with the version tag you pulled.

**For NGINX Plus R33 or later**:

Expand All @@ -79,7 +79,7 @@ sudo docker run \
--env=NGINX_AGENT_TLS_ENABLE=true \
--restart=always \
--runtime=runc \
-d private-registry.nginx.com/nginx-plus/agent:<VERSION_TAG>
-d private-registry.nginx.com/nginx-plus/agent:<version-tag>
```

<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,14 +162,9 @@ When adding a new NGINX instance that is not yet registered with NGINX One, you
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
- After selecting the OS, run the provided command to pull the Docker image.

**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
**Note**: Subject to availability, you can modify the `agentv3:<version-tag>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agentv3:r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).


- From the **OS Type** list, choose the appropriate operating system for your Docker image.
- After selecting the OS, run the provided command to pull the Docker image.

**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).

10. Run the provided command, which includes the data plane key, in your NGINX instance terminal to start the Docker container.

11. Select **Done** to complete the process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,24 +156,36 @@ For NGINX Plus, run:
docker pull private-registry.nginx.com/nginx-plus/base:<version-tag>
```

For NGINX Plus with NGINX Agent, run:
For NGINX Plus with NGINX Agent version 2, run:

```shell
docker pull private-registry.nginx.com/nginx-plus/agent:<version-tag>
```

For NGINX Plus with NGINX Agent version 3, run:

```shell
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
```

For NGINX Plus installed from `nginx` user (rootless installation), run:

```shell
docker pull private-registry.nginx.com/nginx-plus/rootless-base:<version-tag>
```

For NGINX Plus with NGINX Agent installed from `nginx` user (rootless installation), run:
For NGINX Plus with NGINX Agent version 2 installed from `nginx` user (rootless installation), run:

```shell
docker pull private-registry.nginx.com/nginx-plus/rootless-agent:<version-tag>
```

For NGINX Plus with NGINX Agent version 3 installed from `nginx` user (rootless installation), run:

```shell
docker pull private-registry.nginx.com/nginx-plus/rootless-agentv3:<version-tag>
```

For NGINX modules, run:<!-- Is this enough info?-->

```shell
Expand Down