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

Custom upgrade instructions URL #10255

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

Originally created by @pgnuta on GitHub (Sep 17, 2024).

NetBox version

v4.1.0

Feature type

New functionality

Proposed functionality

It would be useful for enterprises who maintain their own deployment/upgrade processes and accompanying documentation if the "Upgrade instructions" URL displayed on the home page when a new Netbox version is available could be customized.

Currently the URL Is hard-coded to "https://docs.netbox.dev/en/stable/installation/upgrading/" in netbox/templates/home.html. I propose that a configuration variable be added, like CUSTOM_UPGRADE_URL, and defaulted it to "https://docs.netbox.dev/en/stable/installation/upgrading/". The configuration variable can then be used when rendering the template.

Use case

Many netbox users have custom methodologies for deploying and upgrading Netbox. Whether that be deployment via automation, docker, test environments etc. In those cases the standard Netbox upgrade instructions may not be appropriate and it may be preferred to refer the operations team to the internal documentation URL.

Database changes

None

External dependencies

Accompanying documentation updates would be required to explain the use of the new configuration variable.

Originally created by @pgnuta on GitHub (Sep 17, 2024). ### NetBox version v4.1.0 ### Feature type New functionality ### Proposed functionality It would be useful for enterprises who maintain their own deployment/upgrade processes and accompanying documentation if the "Upgrade instructions" URL displayed on the home page when a new Netbox version is available could be customized. Currently the URL Is hard-coded to "https://docs.netbox.dev/en/stable/installation/upgrading/" in netbox/templates/home.html. I propose that a configuration variable be added, like CUSTOM_UPGRADE_URL, and defaulted it to "https://docs.netbox.dev/en/stable/installation/upgrading/". The configuration variable can then be used when rendering the template. ### Use case Many netbox users have custom methodologies for deploying and upgrading Netbox. Whether that be deployment via automation, docker, test environments etc. In those cases the standard Netbox upgrade instructions may not be appropriate and it may be preferred to refer the operations team to the internal documentation URL. ### Database changes None ### External dependencies Accompanying documentation updates would be required to explain the use of the new configuration variable.
adam added the type: featurenetbox labels 2025-12-29 21:29:02 +01:00
adam closed this issue 2025-12-29 21:29:02 +01:00
adam commented 2025-12-29 21:29:03 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 23, 2025):

While I appreciate your use case, this seems like a very niche ask. Additionally, directing users to a non-canonical source may lead to confusion should they request help from the community.

@jeremystretch commented on GitHub (Jan 23, 2025): While I appreciate your use case, this seems like a very niche ask. Additionally, directing users to a non-canonical source may lead to confusion should they request help from the community.
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 netbox 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#10255
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?