🧑 Faros Essentials

Git + Jira analytics on your laptop in 10 minutes

Install FlowInstall Flow

πŸ“˜

Prerequisites

Docker Desktop, git, API tokens for your systems.

Make sure you have allocated enough resources for Docker. We recommend to allocate at least 4 CPUs, 4GB of RAM and 10GB of disk space.

Windows, Linux and MacOS are supported. For Windows, you need WSL2.

Here is the script that will install, configure, pull data and direct you to the dashboards. GitHub (Cloud), GitLab (Cloud + Server), Bitbucket (Cloud + Server), Jira (Cloud) are currently supported.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/faros-ai/faros-community-edition/main/install.sh)" _ --source doc_essentials

The script explains what it will do and then pauses before it does it. You will be asked tokens for your Git and/or Jira system. All the data remains on your machine. You can inspect the code here.

API token requirements

SourceToken requirements
GitHubProvide GitHub API token with read permissions: repo, read:org, read:user
GitHub Enterprise ServerNot supported yet.
GitLab, GitLab CE/EEProvide GitLab personal access token token with read permissions: read_api
Bitbucket Cloud, Bitbucket Server/DCVCS: Provide Bitbucket "App Password" with read permissions: Pull Requests : read, Issues: read, Workspace membership :read, Projects: read, Repositories: read

CICD: Provide Bitbucket "App Password" with read permissions: Pipelines: read, Repositories, read
Jira CloudThe integration user needs application access to Jira, the 'Browse Users' global permission, and the 'Browse Project' and 'View Development Tools' permissions for each project
Jira Server/DCNot supported yet.

Analytics

Once Install and Ingestion is over, head to your local Metabase instance that Faros deployed: http://localhost:3000 (user: [email protected], pass: admin).

Quick links:

All charts can be inspected and modified!

Default Git DashboardDefault Git Dashboard

Default Git Dashboard

One of the JIRA DashboardsOne of the JIRA Dashboards

One of the Jira Dashboards


What’s Next

Explore your EngOps data, and add more!