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

Allow docs endpoint to be behind authentication #6675

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

Originally created by @abhi1693 on GitHub (Jul 17, 2022).

NetBox version

v3.2.6

Feature type

New functionality

Proposed functionality

The /static/docs/ should optionally be behind a login page. This can be made optional for backward compatibility.

Use case

The /static/docs/ should optionally be behind a login page for those setups where the developers have added custom plugins with their own documentation. This documentation may hold sensitive information which should only be visible to those with access to the plugin.

As of today, anyone with the base URL can go through the documentation which is not desirable in production environments.

Database changes

I don't think so

External dependencies

I don't know

Originally created by @abhi1693 on GitHub (Jul 17, 2022). ### NetBox version v3.2.6 ### Feature type New functionality ### Proposed functionality The `/static/docs/` should optionally be behind a login page. This can be made optional for backward compatibility. ### Use case The `/static/docs/` should optionally be behind a login page for those setups where the developers have added custom plugins with their own documentation. This documentation may hold sensitive information which should only be visible to those with access to the plugin. As of today, anyone with the base URL can go through the documentation which is not desirable in production environments. ### Database changes I don't think so ### External dependencies I don't know
adam added the type: feature label 2025-12-29 19:43:48 +01:00
adam closed this issue 2025-12-29 19:43:48 +01:00
adam commented 2025-12-29 19:43:48 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 18, 2022):

The /static/docs/ should optionally be behind a login page for those setups where the developers have added custom plugins with their own documentation.

Nothing confidential should appear in the plugin's documentation. Alternatively, you have the option to restrict access to static resources via the frontend HTTP server (e.g. nginx or Apache) configuration, however this is out of scope for NetBox itself.

@jeremystretch commented on GitHub (Jul 18, 2022): > The /static/docs/ should optionally be behind a login page for those setups where the developers have added custom plugins with their own documentation. Nothing confidential should appear in the plugin's documentation. Alternatively, you have the option to restrict access to static resources via the frontend HTTP server (e.g. nginx or Apache) configuration, however this is out of scope for NetBox itself.
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: 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#6675
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?