generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 89
docs: add agent unprivileged doc #297
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
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ca9024f
docs: add agent unprivileged doc
JTorreG 02d3072
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 82db845
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 03143ef
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 72bebda
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG a800c8c
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 5a87918
docs: remove indentation
JTorreG 2eb9e62
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 19aeb75
Update content/agent/installation-upgrade/installation-unprivileged.md
JTorreG 4c9e115
Merge branch 'main' into NMS-45705
JTorreG f00664a
chore: remove separators
JTorreG File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
content/agent/installation-upgrade/installation-unprivileged.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: Run without root privileges | ||
weight: 450 | ||
toc: true | ||
type: how-to | ||
product: Agent | ||
--- | ||
|
||
## Overview | ||
|
||
If the policies of your organization do not allow running processes as root, you can run NGINX Agent under a user without root privileges. | ||
|
||
This also aligns with the principle of least privilege, which is a security concept that limits the access rights of users to the bare minimum permissions they need to perform their work. | ||
|
||
--- | ||
|
||
## Before you begin | ||
|
||
Please note that **root access is required to install NGINX Agent**. The agent can be run under a non-root user after the installation. | ||
|
||
--- | ||
|
||
## Installation | ||
|
||
The installation process involves installing NGINX Plus without root privileges and then installing NGINX Agent: | ||
|
||
### Install NGINX Plus without root privileges | ||
|
||
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. | ||
|
||
{{< note >}} | ||
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. | ||
{{< /note >}} | ||
|
||
### Install NGINX Agent | ||
JTorreG marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
After installing NGINX Plus, you can install NGINX agent following the steps on the [NGINX Agent installation page]({{< ref "/agent/installation-upgrade/installation-oss.md" >}}). | ||
|
||
### Start NGINX Agent | ||
JTorreG marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Run the command corresponding to your operating system to start NGINX Agent: | ||
|
||
{{<bootstrap-table "table table-striped table-bordered">}} | ||
|
||
| Operating System | Command(s) | | ||
|------------------------------------------------------|------------------------------------------------| | ||
| RHEL, CentOS,<br>Rocky Linux, AlmaLinux,<br>Oracle Linux, Ubuntu,<br>Debian, SLES, Amazon Linux | ```sudo systemctl start nginx-agent``` | | ||
| Alpine Linux | ```sudo rc-service nginx-agent start```<br>or<br>```sudo /etc/init.d/nginx-agent start``` | | ||
| FreeBSD | ```sudo service nginx-agent start``` | | ||
|
||
{{</bootstrap-table>}} | ||
|
||
You can confirm that NGINX Agent is running under the same user as NGINX Plus by running the following command: | ||
|
||
```bash | ||
ps aux | grep nginx-agent | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.