> For the complete documentation index, see [llms.txt](https://docs.fact-finder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fact-finder.com/shopware6/fact-finder-web-components-for-shopware-6/install-and-connect.md).

# Install and connect

### Installation

To install the plugin, open your terminal and run the command:

```bash
composer require omikron/shopware6-factfinder
```

After successfully installation, it will be visible in the extensions list. Depending on the Shopware 6 versions the view could be different.

Note: Plugin can only be installed only via composer, unpacking plugin source code directly into Shopware 6 project directory will not work as the plugin contains external dependencies which also needs to be installed.

### Activating the Module

To activate the module, please use the switcher located on the left side of the row with extension info.

After it is installed, its configuration is available under the three dots icon.

### Main Settings

This section contains a plugin configuration, which is required in order for the module to work.

Credentials you will be given should be placed here.

Please remember that you have to clear the store cache in order the new applied configuration to start working.

Server URL - FACT-Finder® instance url

Note: Server URL should contain a used protocol: (e.g. https\://) and should end with an endpoint ( fact-finder )

Channel - Channel you want to serve data from. This field works for each sales channel separately, so you can, for example, adjust FactFinder integration to different store's language versions.

API key - your FACT-Finder® API key

You can check if the above data is correctly set by clicking on the Test Connection button. Please save your settings before clicking on button.

### Update Field Roles

This functionality offers a way to download field roles configured in FACT-Finder®.

Please use this if you don't use feed offered by the plugin or for some reason you have changed the column names.

Note: Updating process is ran for all sales channels, no need to run it separately for each of them

### Sales channels management

The entire plugin configuration must be placed in All Sales Channels:

There are only two fields that can be defined for each sales channel separately:

Channel - you can define different data comes from FACT-Finder®, especially in the case of multi-language stores

Disable FactFinder Web Components on frontend? - allows you to disable FACT-Finder® Web Components integration on the frontend. With this option you can use our plugin only on the sales channels you want.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.fact-finder.com/shopware6/fact-finder-web-components-for-shopware-6/install-and-connect.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.