Internal Sources

When a source system is not reachable over the Internet, e.g internal GitHub Enterprise or Jira Server instances,
you can download and run Faros connectors from your environment. This applies for all vendor sources supported by Faros platform.

  1. Download the latest container of any Faros source. For example for GitHub run:
docker pull farosai/github-feed:latest

📘

Source container naming convention is lowercased vendor name with -feed suffix, e.g for Jira it's jira-feed, for GitLab it's gitlab-feed, for BitBucket it's bitbucket-feed etc.

You can find all the available connectors on our Docker Hub org.

  1. Run it:
docker run farosai/github-feed:latest \
    -u https://prod.api.faros.ai \
    -q GitHubOrg \
    -k $FAROS_API_KEY \
    -t $GITHUB_TOKEN \
    -l $GITHUB_ORG \
    -r repo1,repo2,repo3

Aren't sure which options to use? For help run:

docker run farosai/github-feed:latest --help

If the source that you wish to run internally is a v2 source (Faros Airbyte source or supported Airbyte source) you can do this in several ways:

  1. You can managed your own instance of Airbyte server and set up a connection between the desired source and the airbyte-faros-destination.

  2. You can use our airbyte-local-cli tool to run an Airbyte source and destination without the need for Airbyte server. See the usage documentation.

Create a GitHub App to Authenticate Faros to Multiple Orgs

You can create a GitHub App and install it on your multiple GitHub organizations to easily enable read-only access from the Faros connector to your desired organizations and repositories.

  1. Navigate to either your profile settings page or your organization's settings page and create a new GitHub app.
  • At the bottom of the creation page, select "Any account" to allow your app to be installed any user or organization.
  • The Webhook option is not required.
  • The app requires the following read-only permissions:
    • Repository permissions: Administration, Contents, Issues, Metadata, Projects, Pull Requests
    • Organization permissions: Members
  1. On your app's settings page, create a private key and a client secret. These values, along with the App Id and Client ID, are required by the Faros connector.
  2. Install the GitHub app on your desired organizations. You can either grant access to all repositories in an org, or only grant access to specific repositories per org.
  3. Run the Faros GitHub connector:
docker run farosai/github-feed:latest \
    -u https://prod.api.faros.ai \
    -q GitHubOrg \
    -k $FAROS_API_KEY \
    -a $GITHUB_APP_ID \
    --client-id $GITHUB_APP_CLIENT_ID \
    --client-secret $GITHUB_APP_CLIENT_SECRET \
    -p $GITHUB_APP_PRIVATE_KEY \

Did this page help you?