Stay organized with collections
Save and categorize content based on your preferences.
This tutorial shows how to deploy a simple Cloud Search solution and uses
GitHub as the repository of data to be indexed. Specifically, this
tutorial consists of two sample applications:
A content connector, created with the
Cloud Search Connector SDK, used to index
data found in GitHub repositories. Data indexed includes issues, pull requests,
and the head content of the default branch (master).
A web app that uses the
search widget
to provide a customized search interface.
Prerequisites
This tutorial requires the following prerequisites:
Administrator access to a Google Workspace or Cloud Identity domain with
Cloud Search for Third Party Data Indexing enabled. If you're unable to view
settings in the Admin control panel, either contact your domain administrator
or sign-up for Cloud Search.
To start, you must create an Google Cloud Platform project. This
project forms the basis for creating, enabling, and using all Google Cloud
Platform (GCP) services, including managing APIs, enabling billing, adding and
removing collaborators, and managing permissions.
At the top of the page, click
arrow_drop_down
to the right of "Google Cloud Console." A dialog listing current projects
appears.
Click NEW PROJECT. The New Project screen appears.
In the Project Name field, enter a project name, such as
"SearchTutorial."
(optional) Click Edit to edit the Project ID. The project ID can't be
changed after the project is created, so choose an
ID that meets your needs for the lifetime of the project.
To browse locations for the project, click BROWSE.
Click on a location for your project and click Select.
Click CREATE. The console navigates to the Dashboard page. The project
is created within a few minutes.
You need to enable the Google Cloud Search API and create a service account to
obtain credentials.
In the left navigation, click APIs & Services.
To ensure you are on the newly created project, click the
arrow_drop_down icon to the right of the
Google Cloud console banner and select your newly-created project.
Click ENABLE APIS AND SERVICES. The "Welcome to API Library" page
appears.
Type "Cloud Search API" in the search field and press return. A list
of APIs is returned.
CLick Cloud Search API. The "Cloud Search API" page appears.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[],[],null,["This tutorial shows how to deploy a simple Cloud Search solution and uses\nGitHub as the repository of data to be indexed. Specifically, this\ntutorial consists of two sample applications:\n\n- A content connector, created with the [Cloud Search Connector SDK](/workspace/cloud-search/docs/reference/sdk), used to index data found in GitHub repositories. Data indexed includes issues, pull requests, and the head content of the default branch (`master`).\n- A web app that uses the [search widget](/workspace/cloud-search/docs/guides/search-widget) to provide a customized search interface.\n\n| **Note:** The tutorial content connector is not intended to be used in production and is provided for sample purposes only. For production use, consider creating a [GitHub App](https://developer.github.com/apps/building-your-first-github-app/) to handle indexing.\n\nPrerequisites\n\nThis tutorial requires the following prerequisites:\n\n- Administrator access to a Google Workspace or Cloud Identity domain with Cloud Search for Third Party Data Indexing enabled. If you're unable to view settings in the Admin control panel, either contact your domain administrator or [sign-up for Cloud Search](https://cloud.google.com/products/search/).\n- A [GitHub](https://github.com/) user account.\n- Java and JavaScript familarity.\n- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or newer.\n- [Maven](http://maven.apache.org/install.html).\n- [Node.js](https://nodejs.org/) 8.11 or newer.\n\nCreate the tutorial project\n\nTo start, you must create an Google Cloud Platform project. This\nproject forms the basis for creating, enabling, and using all Google Cloud\nPlatform (GCP) services, including managing APIs, enabling billing, adding and\nremoving collaborators, and managing permissions.\n\n1. Open the [Google Cloud console](https://console.cloud.google.com/).\n\n2. At the top of the page, click\n arrow_drop_down\n to the right of \"Google Cloud Console.\" A dialog listing current projects\n appears.\n\n3. Click **NEW PROJECT**. The New Project screen appears.\n\n4. In the **Project Name** field, enter a project name, such as\n \"SearchTutorial.\"\n\n5. (optional) Click **Edit** to edit the Project ID. The project ID can't be\n changed after the project is created, so choose an\n ID that meets your needs for the lifetime of the project.\n\n6. To browse locations for the project, click **BROWSE**.\n\n7. Click on a location for your project and click **Select**.\n\n8. Click **CREATE**. The console navigates to the Dashboard page. The project\n is created within a few minutes.\n\nFor further information on creating and managing projects, refer to\n[Creating and Managing Projects](https://support.google.com/cloud#topic=6158848).\n\nEnable the API\n\nYou need to enable the Google Cloud Search API and create a service account to\nobtain credentials.\n\n1. In the left navigation, click **APIs \\& Services**.\n2. To ensure you are on the newly created project, click the arrow_drop_down icon to the right of the Google Cloud console banner and select your newly-created project.\n3. Click **ENABLE APIS AND SERVICES**. The \"Welcome to API Library\" page appears.\n4. Type \"Cloud Search API\" in the search field and press **return**. A list of APIs is returned.\n5. CLick **Cloud Search API**. The \"Cloud Search API\" page appears.\n6. Click **ENABLE**. The Overview page appears.\n\nFor further information on enabling and disabling APIs, refer to\n[Manage APIs in the Google Cloud console](https://support.google.com/cloud/answer/6326510)\n| **Note:** Different Google Cloud Search APIs require different accounts to execute (admin, service, and user). For further information, refer to the [reference documentation](/workspace/cloud-search/docs/reference) for the method you want to call.\n\nClone the tutorial repository\n\nTo clone the sample repository, run the following command: \n\n git clone https://github.com/googleworkspace/cloud-search-samples.git\n\n[Next](/workspace/cloud-search/docs/tutorials/end-to-end/setup-connector)"]]