Google Sites Connector Setup

Provide necessary API permissions to index Google Sites.

Installing the Google Sites Connector

Note: For this step, your deployment engineer will be required.

Prerequisites

Google Sites Connector requires you to enable Google Vault for your organization. Google Vault enrollment details are available in the official documentation

You will need a Service Account as described in Grant Service Account Permissions section. In addition to the scopes listed there, you must grant the following scopes to the Service Account:

- https://www.googleapis.com/auth/ediscovery
- https://www.googleapis.com/auth/devstorage.read_only

Vault API access must be manually enabled by the GCP project associated with the Service Account. This can be done via GCP API Console, by following the steps in the official documentation.

Configuration

Once the prerequisites above are completed, you need to configure the connector.

  • ServiceUser, ServiceAccountKey, and Domains are parts of the configuration similar to GMail/GDrive
  • SiteUrls is a list of top-level Google Site URLs you want to index. e.g., https://sites.google.com/your-org/your-site
  • SiteConfigs is an optional map of site-specific configuration you want to setup.

For automatically updating Atolio with recent changes on your Google Site, provide an update frequency to your Deployment Engineer, e.g., every day, every hour, etc.

An example configuration would be as follows:

configuration:
  ...
  site-urls:
    - https://sites.google.com/your-org/your-site
  site-configs:
    https://sites.google.com/your-org/your-site
      # If you have a custom domain for your Google Site, specify it here.
      top-level-url: https://your-custom-domain.com/path

      # If you want to configure deeplinks for each page, 
      # you can do it by providing a "page name" -> "URL suffix" map here.
      # 
      # For a page titled "Home", the deeplink would be:
      # https://your-custom-domain.com/path/home
      page-name-to-url-suffix:
        Home: /home
        About: /about
      
      # If you have setup "Restricted" access for your site, specify it here. 
      # Default is `false`.
      restricted: true

If you do not prefer to have a static configuration for deeplinks, you can also provide a “url path” on each Google Site page. Simply add a text in the form of urlpath:[/relative-path-to-your-page] in the body of each page, and Atolio will index the page with the user-provided deeplink.