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

Installation Documentation Adding Symbolic Link for Nginx #1742

New Issue
Closed
opened 2025-12-29 16:34:54 +01:00 by adam · 3 comments
adam commented 2025-12-29 16:34:54 +01:00
Owner
Copy Link

Originally created by @jnewmaster on GitHub (May 24, 2018).

Issue type

[ ] Feature request
[ ] Bug report
[X] Documentation

Environment

  • Python version: 3.5.1-3
  • NetBox version: 2.3.3

Description

The current documentation for installation > web server > NGINX specifies to create a symbolic link but does not specify the link to create.
Currently states : ln -s /etc/nginx/sites-available/netbox
Proposed to state : ln -s /etc/nginx/sites-available/netbox default

Originally created by @jnewmaster on GitHub (May 24, 2018). <!-- Before opening a new issue, please search through the existing issues to see if your topic has already been addressed. Note that you may need to remove the "is:open" filter from the search bar to include closed issues. Check the appropriate type for your issue below by placing an x between the brackets. For assistance with installation issues, or for any other issues other than those listed below, please raise your topic for discussion on our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please note that issues which do not fall under any of the below categories will be closed. Due to an excessive backlog of feature requests, we are not currently accepting any proposals which extend NetBox's feature scope. Do not prepend any sort of tag to your issue's title. An administrator will review your issue and assign labels as appropriate. ---> ### Issue type [ ] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [X] Documentation <!-- A modification to the documentation --> <!-- Please describe the environment in which you are running NetBox. (Be sure to verify that you are running the latest stable release of NetBox before submitting a bug report.) If you are submitting a bug report and have made any changes to the code base, please first validate that your bug can be recreated while running an official release. --> ### Environment * Python version: 3.5.1-3 <!-- Example: 3.5.4 --> * NetBox version: 2.3.3 <!-- Example: 2.1.3 --> <!-- BUG REPORTS must include: * A list of the steps needed for someone else to reproduce the bug * A description of the expected and observed behavior * Any relevant error messages (screenshots may also help) FEATURE REQUESTS must include: * A detailed description of the proposed functionality * A use case for the new feature * A rough description of any necessary changes to the database schema * Any relevant third-party libraries which would be needed --> ### Description The current documentation for installation > web server > NGINX specifies to create a symbolic link but does not specify the link to create. Currently states : `ln -s /etc/nginx/sites-available/netbox` Proposed to state : `ln -s /etc/nginx/sites-available/netbox default`
adam closed this issue 2025-12-29 16:34:54 +01:00
adam commented 2025-12-29 16:34:55 +01:00
Author
Owner
Copy Link

@bdlamprecht commented on GitHub (May 25, 2018):

I think it makes sense the way it is now.

When creating a symbolic link, if you don't specify a different destination filename, it defaults to the source filename.

If you following exact steps in the documentation, you should create the file netbox in the directory /etc/nginix/sites-enabled/ which is the idea.

From the documentation under the heading Web Server Installation:

# cd /etc/nginx/sites-enabled/
# rm default
# ln -s /etc/nginx/sites-available/netbox

This will remove the placeholder default site with the netbox site.
You can always leave the default there if you want to or even add additional sites if you need nginx to proxy for those as well.

@bdlamprecht commented on GitHub (May 25, 2018): I think it makes sense the way it is now. When creating a symbolic link, if you don't specify a different destination filename, it defaults to the source filename. If you following **exact steps** in the documentation, you should create the file `netbox` in the directory `/etc/nginix/sites-enabled/` which is the idea. From the documentation under the heading `Web Server Installation`: ``` # cd /etc/nginx/sites-enabled/ # rm default # ln -s /etc/nginx/sites-available/netbox ``` This will remove the placeholder `default` site with the `netbox` site. You can always leave the `default` there if you want to or even add additional sites if you need `nginx` to proxy for those as well.
adam commented 2025-12-29 16:34:55 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 2, 2018):

Right, we keep the netbox name because it's plausible that the user might be serving other sites from this instance as well.

@jeremystretch commented on GitHub (Jul 2, 2018): Right, we keep the `netbox` name because it's plausible that the user might be serving other sites from this instance as well.
adam commented 2025-12-29 16:34:56 +01:00
Author
Owner
Copy Link

@jnewmaster commented on GitHub (Jul 2, 2018):

Hey Jeremy,

Sure, then wouldn’t it make sense to specify that then or remove the “rm default” ?

For example,

“ln -s /etc/nginx/sites-available/netbox netbox”

So that there would be less room for misinterpretation.

For example, I am not familiar with NGINX but since it is the first listed I chose that as it appeared to be the most supported, but I did not see it specify the link so I was unsure if it should specify “default” or “netbox”. Especially since the documentation specified deleting “default”. It wasn’t even until I opened this request that I realized that “netbox” would work with NGINX without further configuration.

While I understand a reader having a better understanding of NGINX here would help, I also believe the added specificity would help.

Thanks for taking the time.

EDIT: Also, this is the first time I’m trying Github. If I believe specifying “netbox” would help, would I open a new pull request and issue or just comment on here?
Thanks.

@jnewmaster commented on GitHub (Jul 2, 2018): Hey Jeremy, Sure, then wouldn’t it make sense to specify that then or remove the “rm default” ? For example, “ln -s /etc/nginx/sites-available/netbox netbox” So that there would be less room for misinterpretation. For example, I am not familiar with NGINX but since it is the first listed I chose that as it appeared to be the most supported, but I did not see it specify the link so I was unsure if it should specify “default” or “netbox”. Especially since the documentation specified deleting “default”. It wasn’t even until I opened this request that I realized that “netbox” would work with NGINX without further configuration. While I understand a reader having a better understanding of NGINX here would help, I also believe the added specificity would help. Thanks for taking the time. EDIT: Also, this is the first time I’m trying Github. If I believe specifying “netbox” would help, would I open a new pull request and issue or just comment on here? Thanks.
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
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#1742
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?