You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs.trychroma.com/markdoc/content/cloud/sync/github.md
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ name: GitHub
7
7
8
8
## Direct Sync
9
9
10
-
Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub app. To use your own custom GitHub app, use [Platform Sync](/cloud/sync/overview#platform-sync).
10
+
Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub app. To use your own custom GitHub app, use [Platform Sync](/cloud/sync/github#platform-sync).
11
11
12
12
1.**Prerequisites**
13
13
@@ -57,9 +57,21 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
Platform Sync is only available on Chroma Cloud [Team and Enterprise plans](https://trychroma.com/pricing).
62
+
{% /Banner %}
63
+
64
+
60
65
1.**Prerequisites**
61
66
62
-
This walkthrough assumes that you have an existing GitHub App that has been installed into at least one non-empty GitHub account or organization.
67
+
This walkthrough assumes that you have already [created a GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) and installed it into at least one GitHub account or organization.
68
+
69
+
The GitHub App must have read-only access to the “Contents” and “Metadata” permissions listed under “Repository permissions.” These permissions ensure Chroma can index repositories authorized on the GitHub app.
With these credentials, you can use the Chroma dashboard to register your GitHub App with Chroma. **Contact [[email protected]](mailto:[email protected]) for access to this feature.**
92
+
With these credentials, navigate to the "Sync" -> "New GitHub sync" -> "Register your GitHub app" to configure your GitHub App with Chroma.
Copy file name to clipboardExpand all lines: docs/docs.trychroma.com/markdoc/content/cloud/sync/overview.md
+2-6Lines changed: 2 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,13 +27,9 @@ The direct tier requires you to install Chroma’s GitHub App into any repositor
27
27
28
28
### Platform Sync
29
29
30
-
The platform tier requires you to grant Chroma access to a GitHub App that you own, which has been installed into the private repositories you wish to sync. This GitHub App must have read-only access to the “Contents” and “Metadata” permissions on the list of “Repository permissions”:
30
+
The platform tier requires you to grant Chroma access to a GitHub App that you own, which has been installed into the private repositories you wish to sync. This GitHub App must have read-only access to the “Contents” and “Metadata” permissions on the list of “Repository permissions”.
The platform tier grants access to the Chroma Sync API and is ideal for companies and organizations that offer services which access their users’ codebases. The platform tier is available on Chroma’s Team plan. If you are interested in using it, please reach out to us at [[email protected]](mailto:[email protected]).
32
+
The platform tier grants access to the Chroma Sync API and is ideal for companies and organizations that offer services which access their users’ codebases. For a detailed walkthrough, see [Platform Sync docs](/cloud/sync/github#platform-sync).
0 commit comments