Skip to content

Update agent install docs #559

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

Open
wants to merge 2 commits into
base: agent-release-3.0
Choose a base branch
from

Conversation

john-david3
Copy link

Proposed changes

  • Added detail on how to check if agent is installed
  • Changed sudo systemctl stop nginx-agent to sudo systemctl restart nginx-agent as described in the text above
  • Added a link to setting up NGINX One Console after agent has been installed

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.

@john-david3 john-david3 self-assigned this May 16, 2025
@john-david3 john-david3 requested a review from a team as a code owner May 16, 2025 14:52
@github-actions github-actions bot added documentation Improvements or additions to documentation product/agent NGINX Agent labels May 16, 2025
Copy link

github-actions bot commented May 16, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@john-david3
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

Copy link

Deploy Preview will be available once build job completes!

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

```

1. Connect your NGINX instance to the [NGINX One Console](/nginx-one/how-to/nginx-configs/add-instance/#add-an-instance)

Choose a reason for hiding this comment

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

can we change this to, check the agent log for

"Agent connected"

Choose a reason for hiding this comment

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

sudo cat /var/log/nginx-agent/agent.log | grep "Agent connected"


1. Check the Agent log for `"Agent Connected"`

```

Choose a reason for hiding this comment

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

Please add shell, see example above

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.

2 participants