starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Update the nginx documentation #3227

New Issue
Closed
opened 2025-12-29 18:26:53 +01:00 by adam · 1 comment
adam commented 2025-12-29 18:26:53 +01:00
Owner
Copy Link

Originally created by @smutel on GitHub (Jan 27, 2020).

Change Type

[ ] Addition
[X] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Proposed Changes

In the nginx configuration, the line below:

proxy_set_header X-Forwarded-Host $server_name;

should be replaced by this line to take account of port used to reach netbox:

proxy_set_header X-Forwarded-Host $http_host;

In the previous configuration, nginx assume that you are calling it on port 80. So the next field on the JSON response when you call the API only contains port 80.

Originally created by @smutel on GitHub (Jan 27, 2020). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [ ] Addition [X] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes In the nginx configuration, the line below: ``` proxy_set_header X-Forwarded-Host $server_name; ``` should be replaced by this line to take account of port used to reach netbox: ``` proxy_set_header X-Forwarded-Host $http_host; ``` In the previous configuration, nginx assume that you are calling it on port 80. So the next field on the JSON response when you call the API only contains port 80.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:26:53 +01:00
adam closed this issue 2025-12-29 18:26:53 +01:00
adam commented 2025-12-29 18:26:53 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 29, 2020):

LGTM, but I want to ensure including the port number won't break anything. Per Django's documentation this should be fine.

Testing confirmed that when listening on a default HTTP port (i.e. 80), the port number is omitted from the URLs returned in API responses when $http_host is used, so that should not be an issue.

@jeremystretch commented on GitHub (Jan 29, 2020): LGTM, but I want to ensure including the port number won't break anything. Per [Django's documentation](https://docs.djangoproject.com/en/2.2/ref/settings/#use-x-forwarded-host) this should be fine. Testing confirmed that when listening on a default HTTP port (i.e. 80), the port number is omitted from the URLs returned in API responses when `$http_host` is used, so that should not be an issue.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3227
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?