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.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/faros-ai/faros-community-edition/main/install.sh)" _ --source doc_essentials
This script will:
- Download Faros code repository and setup containers
- Ask you to configure Git and/or Jira sources
- Pull data from those sources to your machine
- Direct you to the dashboards
GitHub (Cloud), GitLab (Cloud + Server), Bitbucket (Cloud + Server), Jira (Cloud) are currently supported. All the data remains on your machine. You can inspect the code here.
|GitHub||Provide GitHub API token with read permissions: repo, read:org, read:user|
|GitHub Enterprise Server||Not supported yet.|
|GitLab, GitLab CE/EE||Provide GitLab personal access token with read permissions: read_api|
|Bitbucket Cloud||Provide Bitbucket "App Password" with read permissions:|
Pull Requests: read
Workspace membership: read
|Bitbucket Server||Not supported yet.|
|Jira Cloud||The 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/DC||Not supported yet.|
All charts can be inspected and modified!
To stop Faros, go to the folder from where you ran the install command and do:
cd faros-community-edition ./stop.sh
To uninstall, you can delete the
faros-community-edition folder. In Docker, you can remove the following volumes:
Updated 7 months ago