diff --git a/frontend/docs/search_from_browser.md b/frontend/docs/search_from_browser.md new file mode 100644 index 000000000..91bf6e971 --- /dev/null +++ b/frontend/docs/search_from_browser.md @@ -0,0 +1,7 @@ +# Search From Browser +We can expose Amundsen search to web browsers to allow searching Amundsen directly from the address bar. +We do this by following the [OpenSearch standard](https://datacadamia.com/web/search/opensearch) and including an `opensearch.xml` file to describe +how to template a search URL. + +We link to this file from `index.html` as long as the FRONTEND_BASE config [variable](https://github.com/amundsen-io/amundsen/blob/22dcca55d1348de677c33de5af5b62528e4cf2b6/frontend/amundsen_application/config.py#L58) is set. +Browsers will automatically follow this link and add Amundsen as a custom search engine. In Chrome these are viewable in `chrome://settings/searchEngines`.