Skip to content

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
merged 11 commits into from
Mar 19, 2025
Merged

docs: add agent unprivileged doc #297

merged 11 commits into from
Mar 19, 2025

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Mar 18, 2025

Proposed changes

As a user,

I want clear documentation on how to run the NGINX Agent as a non-root user,

so that I can adhere to security best practices.

Solution: A new page is required which details how to install the NGINX Agent in non-root mode

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@JTorreG JTorreG self-assigned this Mar 18, 2025
@JTorreG JTorreG requested a review from a team as a code owner March 18, 2025 15:51
@github-actions github-actions bot added documentation Improvements or additions to documentation product/agent NGINX Agent labels Mar 18, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/297/

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM generally, small edit suggestions.

Copy link
Contributor

@nginx-seanmoloney nginx-seanmoloney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JTorreG

@JTorreG JTorreG merged commit f2fb270 into main Mar 19, 2025
9 checks passed
@JTorreG JTorreG deleted the NMS-45705 branch March 19, 2025 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/agent NGINX Agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants