Skip to content
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

Change default REST api config #321

Merged
merged 10 commits into from
Jun 6, 2023
Merged

Change default REST api config #321

merged 10 commits into from
Jun 6, 2023

Conversation

oCHRISo
Copy link
Collaborator

@oCHRISo oCHRISo commented May 26, 2023

Proposed changes

Updating the default NGINX Agent config file to provide a warning of REST api port exposure and to comment out port by default

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

@oCHRISo oCHRISo requested review from oliveromahony and dhurley May 26, 2023 10:55
@netlify
Copy link

netlify bot commented May 26, 2023

Deploy Preview for agent-public-docs canceled.

Name Link
🔨 Latest commit 8012921
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/647f47588702a20008d95e08

nginx-agent.conf Outdated
@@ -38,4 +38,8 @@ config_dirs: "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"

api:
# default port for NGINX Agent API, this is for the server configuration of the REST API
port: 8081
# port: 8081
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the default port? Should we change this to a different suggestion, or leave it blank, to force users to define a different value?

Co-authored-by: Jodie Putrino <[email protected]>
@github-actions github-actions bot added chore Pull requests for routine tasks dependencies labels Jun 6, 2023
@oliveromahony oliveromahony merged commit 32ef235 into main Jun 6, 2023
@oliveromahony oliveromahony deleted the nginx-agent-config branch June 6, 2023 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants