'Installation & Upgrade' Gunicorn documentation page - Add 'Note' section following 'systemd setup' instructions to update '.service' files if default user is not 'netbox' #7216

Closed
opened 2025-12-29 20:20:34 +01:00 by adam · 1 comment
Owner

Originally created by @rsbrooks on GitHub (Nov 10, 2022).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Addition

Area

Installation/upgrade

Proposed Changes

Add a 'Note' section below the 'systemd setup' instructions on the "4. Gunicorn" page in the "Installation & Upgrade" section of the documentation.

Specify that the user needs to update the "User" and "Group" config options in both ".service" files if the default user they created is not named "netbox".

This would hopefully prevent unnecessary confusion and troubleshooting in the following parts of the Gunicorn setup guide, while still keeping the documentation concise.

Suggested addition:

!!! note

    If the default user you created was not 'netbox', you will need to update both of these .service files in the systemd directory with the correct User and Group. Otherwise, the services will fail to start in the following steps and will throw a user credntials error in the journalctl logs.

I'm happy to be assigned to this and create the pull request, if the suggested change above is approved.

Originally created by @rsbrooks on GitHub (Nov 10, 2022). Originally assigned to: @jeremystretch on GitHub. ### Change Type Addition ### Area Installation/upgrade ### Proposed Changes Add a 'Note' section below the 'systemd setup' instructions on the "4. Gunicorn" page in the "Installation & Upgrade" section of the documentation. Specify that the user needs to update the "User" and "Group" config options in both ".service" files if the default user they created is not named "netbox". This would hopefully prevent unnecessary confusion and troubleshooting in the following parts of the Gunicorn setup guide, while still keeping the documentation concise. #### **Suggested addition**: ``` !!! note If the default user you created was not 'netbox', you will need to update both of these .service files in the systemd directory with the correct User and Group. Otherwise, the services will fail to start in the following steps and will throw a user credntials error in the journalctl logs. ``` I'm happy to be assigned to this and create the pull request, if the suggested change above is approved.
adam added the status: acceptedtype: documentation labels 2025-12-29 20:20:34 +01:00
adam closed this issue 2025-12-29 20:20:35 +01:00
Author
Owner

@github-actions[bot] commented on GitHub (Jan 10, 2023):

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. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Jan 10, 2023): 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. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7216