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

Support Redis Unix sockets #9588

New Issue
Closed
opened 2025-12-29 21:19:19 +01:00 by adam · 6 comments
adam commented 2025-12-29 21:19:19 +01:00
Owner
Copy Link

Originally created by @tacerus on GitHub (May 6, 2024).

Originally assigned to: @minijackson on GitHub.

NetBox version

3.7.5

Feature type

Change to existing functionality

Proposed functionality

Support Redis connectivity through Unix sockets

Use case

Binding to Redis servers on localhost or sidecars without exposing a TCP listener.

Database changes

No response

External dependencies

No response

Originally created by @tacerus on GitHub (May 6, 2024). Originally assigned to: @minijackson on GitHub. ### NetBox version 3.7.5 ### Feature type Change to existing functionality ### Proposed functionality Support Redis connectivity through Unix sockets ### Use case Binding to Redis servers on localhost or sidecars without exposing a TCP listener. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featurecomplexity: medium labels 2025-12-29 21:19:19 +01:00
adam closed this issue 2025-12-29 21:19:20 +01:00
adam commented 2025-12-29 21:19:20 +01:00
Author
Owner
Copy Link

@tacerus commented on GitHub (May 6, 2024):

https://github.com/netbox-community/netbox/issues/15955
https://github.com/netbox-community/netbox/issues/4377
https://github.com/netbox-community/netbox/pull/15590

@tacerus commented on GitHub (May 6, 2024): https://github.com/netbox-community/netbox/issues/15955 https://github.com/netbox-community/netbox/issues/4377 https://github.com/netbox-community/netbox/pull/15590
adam commented 2025-12-29 21:19:20 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (May 6, 2024):

From previous tickets:

Proposed Functionality

Implement unix-socket support for Redis cache and webhook

Use Case

When Redis is installed on the same Server as netbox, then the possible usage of unix sockets for redis would be nice. When using unix sockets, there is no need for localhost loopback with the whole IP-Stack. The usage with unix sockets can improve the performance too (even if it doesn't matter).

Database Changes

No DB-Changes needed. Just some small changes in settings.py and configuration.py

@arthanson commented on GitHub (May 6, 2024): From previous tickets: ### Proposed Functionality Implement unix-socket support for Redis cache and webhook ### Use Case When Redis is installed on the same Server as netbox, then the possible usage of unix sockets for redis would be nice. When using unix sockets, there is no need for localhost loopback with the whole IP-Stack. The usage with unix sockets can improve the performance too (even if it doesn't matter). ### Database Changes No DB-Changes needed. Just some small changes in settings.py and configuration.py
adam commented 2025-12-29 21:19:20 +01:00
Author
Owner
Copy Link

@minijackson commented on GitHub (May 7, 2024):

Hello, I have a patch that I'm willing to upstream that was made to support Redis Unix sockets.

(Note: the linked patch also modifies STATIC_ROOT, but this modification is not part of the proposed changes)

This patch defines new REDIS['tasks']['URL'] and REDIS['caching']['URL'] settings, which take priority if defined by the user. The user can then set this config if they want to use Unix sockets:

REDIS = {
    "tasks": {"URL": "unix:///run/redis-netbox/redis.sock?db=0", "SSL": False},
    "caching": {"URL": "unix:///run/redis-netbox/redis.sock?db=1", "SSL": False},
}

In the case of the tasks Redis database, if and only if URL is defined, NetBox would use it.

In the case of the caching Redis database, URL is always used, but defaults to the value that was used before the patch.

This should be backwards compatible.

@minijackson commented on GitHub (May 7, 2024): Hello, I have [a patch](https://github.com/NixOS/nixpkgs/blob/dd1290b0f857782a60b251f89651c831cd3eef9d/pkgs/servers/web-apps/netbox/config.patch) that I'm willing to upstream that was made to support Redis Unix sockets. (Note: the linked patch also modifies `STATIC_ROOT`, but this modification is not part of the proposed changes) This patch defines new `REDIS['tasks']['URL']` and `REDIS['caching']['URL']` settings, which take priority if defined by the user. The user can then set this config if they want to use Unix sockets: ```python REDIS = { "tasks": {"URL": "unix:///run/redis-netbox/redis.sock?db=0", "SSL": False}, "caching": {"URL": "unix:///run/redis-netbox/redis.sock?db=1", "SSL": False}, } ``` In the case of the tasks Redis database, if and only if `URL` is defined, NetBox would use it. In the case of the caching Redis database, `URL` is always used, but defaults to the value that was used before the patch. This should be backwards compatible.
adam commented 2025-12-29 21:19:21 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 7, 2024):

@minijackson sounds good, I'll assign this to you for a PR. Thanks!

@jeremystretch commented on GitHub (May 7, 2024): @minijackson sounds good, I'll assign this to you for a PR. Thanks!
adam commented 2025-12-29 21:19:21 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 21, 2024):

@minijackson are you still interested in working on this?

@jeremystretch commented on GitHub (May 21, 2024): @minijackson are you still interested in working on this?
adam commented 2025-12-29 21:19:21 +01:00
Author
Owner
Copy Link

@minijackson commented on GitHub (May 21, 2024):

Yes, sorry. Went on a quick vacation, then that task fell through the cracks. I'll submit a PR soon.

@minijackson commented on GitHub (May 21, 2024): Yes, sorry. Went on a quick vacation, then that task fell through the cracks. I'll submit a PR soon.
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 complexity: medium status: accepted 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#9588
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?