> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Implement the OpenSearch protocol with Vue InstantSearch
> Learn how to integrate the OpenSearch protocol into your website with Vue InstantSearch.
This project is unrelated to AWS OpenSearch.
This page describes how to implement the [OpenSearch protocol](https://github.com/dewitt/opensearch) with InstantSearch.
The OpenSearch protocol lets you describe a search engine for your website,
so that browsers or other search clients can use that search engine.
## How OpenSearch works
In your website or web application, you include a link to an OpenSearch description document.
In this document, you describe how browsers can interact with an underlying search engine.
This interaction is based on URL templates, for example, `https://mysite.com?q={searchTerms}`,
which tell browsers how to make a search request.
Since the interaction between the browser and search engine is based on a URL,
you need to enable [URL synchronization](/doc/guides/building-search-ui/going-further/routing-urls/vue).
{/* vale Google.Headings = NO */}
## Create an OpenSearch description document
The OpenSearch description document is an XML file following the [OpenSearch specification](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md).
For example:
```xml XML theme={"system"}
Example Web SearchSearch example.com content.UTF-8linkToImage
```
To adapt this example to your website, update these parts:
* `` is the name of your app or website search. It must be 16 or fewer characters.
* `` is a human readable description of your search engine. It must be 1024 or fewer characters.
* `` has the `template` attribute, that browsers use to create the URL to your search engine.
* `` has a URL (linkToImage) to a PNG image that represents your website, for example, the favicon.
The XML document must be served with `Content-Type: application/opensearchdescription+xml` media type.
For more information, see [OpenSearch description elements](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#opensearch-description-elements).
## Include the OpenSearch description document in your website
You can reference the XML document in the `` of your web pages:
```html HTML theme={"system"}
```
For more information, see
[Autodiscovery in HTML](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#autodiscovery-in-htmlxhtml)