> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up the Cognite File extractor

> Install and configure the Cognite File extractor on Windows and Linux systems.

## Before you start

* Check the [server requirements](/cdf/integration/guides/extraction/file/file_requirements) for the extractor.
* Assign [access capabilities](/cdf/access/guides/capabilities#file-extractor) in a CDF project.

<Tip>
  You can use OpenID Connect and your existing identity provider (IdP) framework to manage access to CDF data securely. [Read more](/cdf/integration/guides/extraction/admin_oidc).
</Tip>

* Set up a Windows Update schedule. Note that the update may reboot the machine, causing extractor downtime.
* Navigate to **Data fusion** > **Integrate** > **Extractors** to download the Windows executable file.

<Info>
  Set Modify permission under Properties in the installation folder to avoid permission issues.
</Info>

* Create a configuration file according to the [configuration settings](/cdf/integration/guides/extraction/configuration/file-extractor). The file must be in YAML format.

## Run as a Windows standalone executable file

<Steps>
  <Step title="Download the executable">
    Download the `file_extractor-{VERSION}-win32.exe` file via the download links available from the Cognite File extractor section on the **Extract data** page in the CDF user interface.
  </Step>

  <Step title="Save the file">
    Save the file in a folder.
  </Step>

  <Step title="Run the file">
    Open a command line window and run the file with a configuration file as an argument.

    In this example, the configuration file is named `config.yml` and saved in the same folder as the executable file:

    ```bash theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
    .\file-extractor-standalone-{VERSION}-win32.exe ./config.yml
    ```
  </Step>
</Steps>

## Install and run the extractor

<Tabs>
  <Tab title="Windows">
    ### Install using Windows installer

    <Steps>
      <Step title="Download the installer">
        Download the `file-extractor-{VERSION}-win32.msi` file via the download links available from the Cognite File extractor section on the **Extract data** page in the CDF user interface.
      </Step>

      <Step title="Save the file">
        Save the file in a folder.
      </Step>

      <Step title="Navigate to the folder">
        Navigate to the folder where you saved the file.
      </Step>

      <Step title="Install the extractor">
        Double-click the file, or type the below command in a command line window to install the extractor.

        ```bash theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
        .\file-extractor-{VERSION}.msi
        ```
      </Step>
    </Steps>

    ### Run as standalone executable

    <Steps>
      <Step title="Download the executable">
        Download the `file_extractor-{VERSION}-win32.exe` file via the download links available from the Cognite File extractor section on the **Extract data** page in the CDF user interface.
      </Step>

      <Step title="Save the file">
        Save the file in a folder.
      </Step>

      <Step title="Run the file">
        Open a command line window and run the file with a configuration file as an argument.

        In this example, the configuration file is named `config.yml` and saved in the same folder as the executable file:

        ```bash theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
        .\file-extractor-standalone-{VERSION}-win32.exe ./config.yml
        ```
      </Step>
    </Steps>

    ### Run as Windows service

    <Steps>
      <Step title="Download the service executable">
        Download the `file-extractor-service-{VERSION}-win32.exe` file via the download links available from the Cognite File extractor section on the **Extract data** page in the CDF user interface.
      </Step>

      <Step title="Save the file">
        Save the file to the same directory as a configuration file named `config.yaml`. This must be the exact name of the file.
      </Step>

      <Step title="Install the service">
        As an administrator, open up the command line window in the folder you placed the executable file and the configuration file and run the following command:

        ```bash theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
        .\file-extractor-winservice-{VERSION}-win32.exe install
        ```
      </Step>

      <Step title="Open the Services app">
        Open the **Services** app in Windows and find the **Cognite File Extractor Executor** service.
      </Step>

      <Step title="Configure the service">
        Right-click the service and select **Properties**.
      </Step>

      <Step title="Adjust settings">
        Configure the service per your needs/requirements.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Linux">
    ### Run as standalone executable

    <Steps>
      <Step title="Download the Linux executable">
        Download the `file_extractor-standalone-{VERSION}-linux` file via the download links available from the Cognite File extractor section on the **Extract data** page in the CDF user interface.
      </Step>

      <Step title="Save the file">
        Save the file in a directory.
      </Step>

      <Step title="Run the file">
        Open a terminal window, and run the file with its configuration file as an argument.

        In this example, the configuration file is named `config.yml` and saved in the same folder as the executable file:

        ```bash theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
        ./file-extractor-standalone-{VERSION}-linux ./config.yml
        ```
      </Step>
    </Steps>
  </Tab>
</Tabs>