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

systemd unit file note #3243

New Issue
Closed
opened 2025-12-29 18:27:02 +01:00 by adam · 13 comments
adam commented 2025-12-29 18:27:02 +01:00
Owner
Copy Link

Originally created by @oidz1234 on GitHub (Jan 29, 2020).

Change Type

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

Proposed Changes

I would like to contribute a note to the documentation. It will inform the reader of the need to change the user the services are running as. The reason for this is that on different distributions Apache runs as different users. For example, On Ubuntu the user is "www-data" Whereas on CentOS it is "apache"

Originally created by @oidz1234 on GitHub (Jan 29, 2020). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [X ] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes I would like to contribute a note to the documentation. It will inform the reader of the need to change the user the services are running as. The reason for this is that on different distributions Apache runs as different users. For example, On Ubuntu the user is "www-data" Whereas on CentOS it is "apache"
adam added the type: documentation label 2025-12-29 18:27:02 +01:00
adam closed this issue 2025-12-29 18:27:02 +01:00
adam commented 2025-12-29 18:27:02 +01:00
Author
Owner
Copy Link

@dsg-anthony commented on GitHub (Jan 29, 2020):

Should users use the www-data/apache user or should users create a separate user to run the netbox service?

@dsg-anthony commented on GitHub (Jan 29, 2020): Should users use the www-data/apache user or should users create a separate user to run the netbox service?
adam commented 2025-12-29 18:27:02 +01:00
Author
Owner
Copy Link

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

I belive it to be fine to use whatever the default system user that apache runs as.

@oidz1234 commented on GitHub (Jan 29, 2020): I belive it to be fine to use whatever the default system user that apache runs as.
adam commented 2025-12-29 18:27:02 +01:00
Author
Owner
Copy Link

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

What specifically do you want to add/change?

@jeremystretch commented on GitHub (Jan 29, 2020): What specifically do you want to add/change?
adam commented 2025-12-29 18:27:02 +01:00
Author
Owner
Copy Link

@oidz1234 commented on GitHub (Jan 30, 2020):

I would like to add a small note about making sure your netbox systemd service is running under the correct user.
Please see this closed PR:
https://github.com/netbox-community/netbox/pull/4042

@oidz1234 commented on GitHub (Jan 30, 2020): I would like to add a small note about making sure your netbox systemd service is running under the correct user. Please see this closed PR: https://github.com/netbox-community/netbox/pull/4042
adam commented 2025-12-29 18:27:02 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Jan 30, 2020):

I do think we should have something, not sure what the best way to phrase it would be.

Nginx runs as nobody or nginx on Centos by default, I can't remember which though

@DanSheps commented on GitHub (Jan 30, 2020): I do think we should have something, not sure what the best way to phrase it would be. Nginx runs as nobody or nginx on Centos by default, I can't remember which though
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@dsg-anthony commented on GitHub (Jan 30, 2020):

You could just create a new system user

useradd -r netbox

This should work on all mainstream Linux distros and reduce the confusion on what account to run with. 😉

It does add a bit of confusion when managing file permissions though.

@dsg-anthony commented on GitHub (Jan 30, 2020): You could just create a new system user `useradd -r netbox` This should work on all mainstream Linux distros and reduce the confusion on what account to run with. 😉 It does add a bit of confusion when managing file permissions though.
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@oidz1234 commented on GitHub (Feb 3, 2020):

I think using the default system user for installation is best practice. Also I have only installed netbox under Apache. If default Nginx user differs between distributions then this will also need a note.

Or just have a note making sure the user checks?

@oidz1234 commented on GitHub (Feb 3, 2020): I think using the default system user for installation is best practice. Also I have only installed netbox under Apache. If default Nginx user differs between distributions then this will also need a note. Or just have a note making sure the user checks?
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@candlerb commented on GitHub (Feb 3, 2020):

I'd say creating a distinct 'netbox' user is best practice (and this is what I do). If you have multiple web apps on a server, then for security you want them all running as distinct uids, not all as "www-data" or whatever.

There is some potential for confusion for existing users though, if the documentation now changes to using a "netbox" user.

@candlerb commented on GitHub (Feb 3, 2020): I'd say creating a distinct 'netbox' user is best practice (and this is what I do). If you have multiple web apps on a server, then for security you want them all running as distinct uids, not all as "www-data" or whatever. There is some potential for confusion for existing users though, if the documentation now changes to using a "netbox" user.
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@oidz1234 commented on GitHub (Feb 4, 2020):

If that is the agreed method then fine. Although there will be many more places (I expect) In the documentation that will need to be updated also.

@oidz1234 commented on GitHub (Feb 4, 2020): If that is the agreed method then fine. Although there will be many more places (I expect) In the documentation that will need to be updated also.
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Feb 4, 2020):

I think the only issue with this is certain files need to be readable by the webserver, so either they need to be chgrp to the webserver group or world readable.

Both of which adds an additional step to ensure everything is good.

@DanSheps commented on GitHub (Feb 4, 2020): I think the only issue with this is certain files need to be readable by the webserver, so either they need to be chgrp to the webserver group or world readable. Both of which adds an additional step to ensure everything is good.
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 4, 2020):

Let's be cognizant of the scope of the documentation we provide. It's very easy to wander away from installing NetBox to discussing alternative installations, best configuration practices, and so on. The installation docs have always assumed a basic level of understanding around configuring an HTTP service, which includes determining the user under which the service should run.

I think it's fine to mention creating a "netbox" user as an option, but let's not deviate any further from what exists today.

@jeremystretch commented on GitHub (Feb 4, 2020): Let's be cognizant of the scope of the documentation we provide. It's very easy to wander away from installing NetBox to discussing alternative installations, best configuration practices, and so on. The installation docs have always assumed a basic level of understanding around configuring an HTTP service, which includes determining the user under which the service should run. I think it's fine to mention creating a "netbox" user as an option, but let's not deviate any further from what exists today.
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Mar 6, 2020):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@stale[bot] commented on GitHub (Mar 6, 2020): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 18:27:03 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 6, 2020):

This was ultimately addressed during the alteration of the installation instructions under #3949.

@jeremystretch commented on GitHub (Mar 6, 2020): This was ultimately addressed during the alteration of the installation instructions under #3949.
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 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#3243
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?