> For the complete documentation index, see [llms.txt](https://docs.elimity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/ntfs.md).

# NTFS

The NTFS connector for Elimity Insights fetches trustees, access rights and files for an NTFS file system so you can keep in control of your environment. Follow the instructions below to set up the connector for your environment.

## 1. Setting up a gateway

The Elimity Insights built-in connector for NTFS reads permissions from a local filesystem. Of course it's often not feasible to make these filesystems actually 'local' to your Elimity Insights server. Therefore we ask our customers to set up an additional point of indirection: each deployment of the Elimity Insights built-in connector for NTFS should communicate with an on-prem instance of the Elimity Insights gateway for NTFS. Only the on-prem gateway instance has direct access to its local filesystem. Refer to [the documentation about our NTFS gateway](https://docs.elimity.com/gateways-ntfs/) for detailed setup instructions.

{% hint style="info" %}
This version of the connector is currently compatible with gateway versions matching `>=2.0.0`.
{% endhint %}

Note down your gateway's URL.

## 2. Creating a source in Elimity Insights

In Elimity Insights you can now create a new NTFS source providing the following configuration options:

<table data-full-width="true"><thead><tr><th>Configuration option</th><th>Description</th></tr></thead><tbody><tr><td>Gateway URL</td><td>HTTP(S) URL of the Elimity Insights NTFS gateway you set up in step 1.</td></tr><tr><td>Targets</td><td>HJSON object mapping file labels to paths from which you want to start scanning; refer to <a href="/pages/UIzbwJyFFDUjglwQeodS">our documentation about targets configuration</a> for more details.</td></tr><tr><td>Max depth</td><td>Maximum level of directory nesting; use <code>0</code> to set no limit.</td></tr><tr><td>Only directories</td><td>Indicates whether to only scan directories.</td></tr><tr><td>Omit advanced access rights</td><td>Indicates whether to only import basic access rights.</td></tr><tr><td>Maximum concurrency</td><td>Maximum number of concurrent workers to use for scanning.</td></tr><tr><td>Overrides</td><td>HJSON object mapping file labels to configuration overrides; refer to <a href="/pages/FX9do3RIJy3IGoxd7lzK">our documentation about overrides configuration</a> for more details.</td></tr><tr><td>Skip patterns</td><td>Newline-delimited list of path patterns; the connector will skip files that match (cf. <a href="https://pkg.go.dev/path/filepath#Match"><code>filepath.Match</code></a>) with any of them.</td></tr></tbody></table>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/ntfs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.