Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document the opensearch.xml file #1753

Merged
merged 2 commits into from
Mar 8, 2022
Merged

docs: document the opensearch.xml file #1753

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06366e9
Create search_from_browser.md
Mar 8, 2022
30dad9e
Update search_from_browser.md
Mar 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions frontend/docs/search_from_browser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.