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

Require running the rq-worker process #2793

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

Originally created by @lampwins on GitHub (Aug 7, 2019).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version: 3.7
  • NetBox version: 2.6.2

Proposed Functionality

Require users to always enable and run the rqworker process as a part of their NetBox installation.

Because of the changes in 2.6 which required Redis and its related dependencies, most of this is just documentation to ensure the rqworker is always running and no longer an optional installation step.

That being said, there is some logic surrounding the WEBHOOKS_ENABLED setting that should be removed which conditionally adds django_rq to the list of installed apps.

Use Case

Making the rqworker process optional has turned out to cause a lot of trouble for new users and creates unnecessary conditional logic in the installation instructions.

Requiring the rqworker to be run, unifies NetBox installations and also opens the door to implementing more background processing features such as #2006, #3351, and more.

Database Changes

None

External Dependencies

Move django-rq to a required dependency. All others became required in 2.6.

Originally created by @lampwins on GitHub (Aug 7, 2019). Originally assigned to: @jeremystretch on GitHub. <!-- NOTE: This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.7 * NetBox version: 2.6.2 <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Require users to always enable and run the rqworker process as a part of their NetBox installation. Because of the changes in 2.6 which required Redis and its related dependencies, most of this is just documentation to ensure the rqworker is always running and no longer an optional installation step. That being said, there is some logic surrounding the `WEBHOOKS_ENABLED` setting that should be removed which conditionally adds `django_rq` to the list of installed apps. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case Making the rqworker process optional has turned out to cause a lot of trouble for new users and creates unnecessary conditional logic in the installation instructions. Requiring the rqworker to be run, unifies NetBox installations and also opens the door to implementing more background processing features such as #2006, #3351, and more. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes None <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies Move django-rq to a required dependency. All others became required in 2.6.
adam added the status: acceptedtype: featuretype: documentation labels 2025-12-29 18:22:12 +01:00
adam closed this issue 2025-12-29 18:22:12 +01:00
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 type: feature
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#2793
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?