-
Notifications
You must be signed in to change notification settings - Fork 148
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Tim Grein <[email protected]> Co-authored-by: Praveen Kukreja <[email protected]>
- Loading branch information
1 parent
1d0db36
commit 82e3131
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
### Setting up the GitHub connector | ||
|
||
See the [Developer guide](../../docs/DEVELOPING.md) for setting up connectors. | ||
|
||
## Document level security | ||
|
||
Document level security (DLS) enables you to restrict access to documents based on user permissions. This feature is only available, if the `Repository Type` is set to `Organization` in the GitHub connector. | ||
|
||
Refer to [document level security](https://www.elastic.co/guide/en/enterprise-search/master/dls.html) for more information. | ||
|
||
**Note:** Refer to [DLS in Search Applications](https://www.elastic.co/guide/en/enterprise-search/master/dls-e2e-guide.html) to learn how to ingest data from GitHub with DLS enabled, when building a search application. | ||
|
||
#### Additional Configuration | ||
|
||
##### `Enable document level security` | ||
|
||
Toggle to enable [document level security (DLS)](https://www.elastic.co/guide/en/enterprise-search/master/dls.html). When enabled: | ||
- Full syncs will fetch access control lists for each document and store them in the `_allow_access_control` field. | ||
- Access control syncs will fetch users' access control lists and store them in a separate index. |