Skip to content

Commit 7ce65cb

Browse files
docs
1 parent feb8ece commit 7ce65cb

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

docs/docs/configuration/environment-variables.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ The following environment variables allow you to configure your Sourcebot deploy
3535
| `SOURCEBOT_STRUCTURED_LOGGING_FILE` | - | <p>Optional file to log to if structured logging is enabled</p> |
3636
| `SOURCEBOT_TELEMETRY_DISABLED` | `false` | <p>Enables/disables telemetry collection in Sourcebot. See [this doc](/docs/overview.mdx#telemetry) for more info.</p> |
3737
| `DEFAULT_MAX_MATCH_COUNT` | `10000` | <p>The default maximum number of search results to return when using search in the web app.</p> |
38+
| `ALWAYS_INDEX_FILE_PATTERNS` | - | <p>A comma separated list of glob patterns matching file paths that should always be indexed, regardless of size or number of trigrams.</p> |
3839

3940
### Enterprise Environment Variables
4041
| Variable | Default | Description |

docs/docs/connections/overview.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,26 @@ To learn more about how to create a connection for a specific code host, check o
6969

7070
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).</Note>
7171

72+
## Indexing Large Files
73+
74+
By default, Sourcebot will skip indexing files that are larger than 2MB or have more than 20,000 trigrams. You can configure this by setting the `maxFileSize` and `maxTrigramCount` [settings](/docs/configuration/config-file#settings).
75+
76+
These limits can be ignored for specific files by passing in a comma separated list of glob patterns matching file paths to the `ALWAYS_INDEX_FILE_PATTERNS` environment variable. For example:
77+
78+
```bash
79+
# Always index all .sum and .lock files
80+
ALWAYS_INDEX_FILE_PATTERNS=**/*.sum,**/*.lock
81+
```
82+
83+
Files that have been skipped are assigned the `skipped` language. You can view a list of all skipped files by using the following query:
84+
```
85+
lang:skipped
86+
```
87+
88+
## Indexing Binary Files
89+
90+
Binary files cannot be indexed by Sourcebot. See [#575](https://github.com/sourcebot-dev/sourcebot/issues/575) for more information.
91+
7292

7393
## Schema reference
7494
---

0 commit comments

Comments
 (0)