Skip to content

Add environment variables table to Configuration Overview #532

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 1 commit into from
May 7, 2025

Conversation

nginx-seanmoloney
Copy link
Contributor

Proposed changes

This PR adds a new NGINX Agent configuration options section to the configuration-overview.md documentation. It provides a clear table listing all environment variables, their descriptions, and default values to help users configure the agent correctly.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

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.

@nginx-seanmoloney nginx-seanmoloney requested review from a team as code owners May 7, 2025 12:39
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) product/nginx-one NGINX One Console product/agent NGINX Agent tooling Back end, repository, Hugo, and all things not related to content labels May 7, 2025
@nginx-seanmoloney nginx-seanmoloney changed the base branch from main to agent-release-3.0 May 7, 2025 12:43
Copy link

github-actions bot commented May 7, 2025

Deploy Preview will be available once build job completes!

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

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.

Generally LGTM.

@JTorreG I feel the table information already is or could be an include for re-use.

@nginx-seanmoloney nginx-seanmoloney merged commit dda165a into agent-release-3.0 May 7, 2025
9 checks passed
@nginx-seanmoloney nginx-seanmoloney deleted the add-env-vars-table branch May 7, 2025 14:08
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 product/nginx-one NGINX One Console product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) tooling Back end, repository, Hugo, and all things not related to content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants