Offer search via OpenSearch #6587

Closed
opened 2025-12-29 19:42:40 +01:00 by adam · 6 comments
Owner

Originally created by @thomas-mc-work on GitHub (Jun 23, 2022).

NetBox version

v3.1.11

Feature type

New functionality

Proposed functionality

Offer the search feature according to the OpenSearch standard.

see https://developer.mozilla.org/en-US/docs/Web/OpenSearch

Use case

This very tiny feature would allow users to add their NetBox instance as a search engine directly in their browser.

Database changes

Database not affected

External dependencies

None

Originally created by @thomas-mc-work on GitHub (Jun 23, 2022). ### NetBox version v3.1.11 ### Feature type New functionality ### Proposed functionality Offer the search feature according to the OpenSearch standard. see https://developer.mozilla.org/en-US/docs/Web/OpenSearch ### Use case This very tiny feature would allow users to add their NetBox instance as a search engine directly in their browser. ### Database changes Database not affected ### External dependencies None
adam added the type: featurestatus: needs ownerpending closure labels 2025-12-29 19:42:40 +01:00
adam closed this issue 2025-12-29 19:42:40 +01:00
Author
Owner

@adamboutcher commented on GitHub (Jun 24, 2022):

This could be really helpful, especially for mobile/handheld devices

@adamboutcher commented on GitHub (Jun 24, 2022): This could be really helpful, especially for mobile/handheld devices
Author
Owner

@adamboutcher commented on GitHub (Jun 24, 2022):

I think something like this might work:

In the global head:

<head>
  <link rel="search" type="application/opensearchdescription+xml" title="Netbox Search" href="./NetboxAllOSearch.xml" />
</head>

NetboxAllOSearch.xml:

<?xml version="1.0" encoding="UTF-8" ?> 
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
     <ShortName>Netbox</ShortName>
     <Description>Netbox All Objects Search</Description>
     <Image width="16" height="16" type="image/x-icon">[https://nextbox.example.com/favicon.ico]</Image>
     <Url type="text/html" template="https://netbox.example.com/search/?q={searchTerms}"/>
</OpenSearchDescription>
@adamboutcher commented on GitHub (Jun 24, 2022): I think something like this might work: In the global head: ``` <head> <link rel="search" type="application/opensearchdescription+xml" title="Netbox Search" href="./NetboxAllOSearch.xml" /> </head> ``` NetboxAllOSearch.xml: ``` <?xml version="1.0" encoding="UTF-8" ?> <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"> <ShortName>Netbox</ShortName> <Description>Netbox All Objects Search</Description> <Image width="16" height="16" type="image/x-icon">[https://nextbox.example.com/favicon.ico]</Image> <Url type="text/html" template="https://netbox.example.com/search/?q={searchTerms}"/> </OpenSearchDescription> ```
Author
Owner

@github-actions[bot] commented on GitHub (Aug 24, 2022):

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 (Aug 24, 2022): 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).
Author
Owner

@cpund commented on GitHub (Sep 7, 2022):

New functionality

Proposed functionality

Offer the search feature according to the OpenSearch standard.

see https://developer.mozilla.org/en-US/docs/Web/OpenSearch

Use case

This very tiny feature would allow users to add their NetBox instance as a search engine directly in their browser.

If I'm understanding what this means, it is already working, no? At least per Mozilla's featureset, I can right click the search box in Netbox and give it a keyword (nb, in my case), and then type "nb John Smith" in the Firefox address bar and it'll search Netbox and my contact named John Smith shows up.

@cpund commented on GitHub (Sep 7, 2022): > New functionality > ### Proposed functionality > > Offer the search feature according to the OpenSearch standard. > > see https://developer.mozilla.org/en-US/docs/Web/OpenSearch > ### Use case > > This very tiny feature would allow users to add their NetBox instance as a search engine directly in their browser. If I'm understanding what this means, it is already working, no? At least per Mozilla's featureset, I can right click the search box in Netbox and give it a keyword (nb, in my case), and then type "nb John Smith" in the Firefox address bar and it'll search Netbox and my contact named John Smith shows up.
Author
Owner

@a084ed22 commented on GitHub (Sep 8, 2022):

If I'm understanding this issue correctly, what is proposed here is slightly different from Mozilla's option available through right click on the search box, but is rather about the magnifying glass that appears in firefox's search bar, like in this example:
image

@a084ed22 commented on GitHub (Sep 8, 2022): If I'm understanding this issue correctly, what is proposed here is slightly different from Mozilla's option available through right click on the search box, but is rather about the magnifying glass that appears in firefox's search bar, like in this example: ![image](https://user-images.githubusercontent.com/90847254/189121282-1bada6be-cf41-43cf-bbfb-2c92caccd470.png)
Author
Owner

@thomas-mc-work commented on GitHub (Sep 8, 2022):

@a084ed22 is right. That is a different feature. The former one works with almost every text field, but it only assigns a shortcut key so be used in the address bar. The latter is the proper search engine integration.

@thomas-mc-work commented on GitHub (Sep 8, 2022): @a084ed22 is right. That is a different feature. The former one works with almost every text field, but it only assigns a shortcut key so be used in the address bar. The latter is the proper search engine integration.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6587