Skip to content

asteroncall/aster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

205 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aster logo

The open source AI on-call engineer

Aster

Aster is an AI on-call engineer. It integrates with your observability stack, codebase and the tools you work with to autonomously investigate production incidents. Think machines on-call for humans, not the other way around.

How it works

  1. Create an account and invite your teammates.

  2. Connect Aster to your observability stack, e.g., Sentry, Datadog.

  3. ⁠Connect Aster to GitHub, Slack/Teams, and any other tools you work with when triaging/troubleshooting, e.g., PagerDuty, Jira.

  4. ⁠Create your organization's knowledge graph to ingest data from the tools you connected in the previous step. The knowledge graph allows Aster to search for contextual information that might be relevant to an incident.

  5. Once these steps are complete, Aster will automatically get added to your Slack/Teams and start investigating alerts for you.

Getting started

To run Aster, clone the repo and run the app using Docker Compose.

Prerequisites

The app uses Docker containers. To run it, you need to have Docker Desktop, which comes with Docker CLI, Docker Engine and Docker Compose.

Installation

Clone the repository:

git clone git@github.com:asteroncall/aster.git && cd aster

Copy the .env.example file:

cp .env.example .env

Open the .env file in your editor:

vscode .env # or emacs or vim or nano

Update these variables:

  • OPENAI_API_KEY - Your OpenAI API key (get it from here)

  • JWT_SIGNING_SECRET - Secret for signing JWT tokens (generate with openssl rand -base64 32)

  • SLACK_APP_TOKEN and SLACK_SIGNING_SECRET - If you use Slack, follow this guide to create a Slack app for Aster in your organization

  • MICROSOFT_TEAMSBOT_URL, MICROSOFT_TEAMS_APP_ID, MICROSOFT_APP_ID, MICROSOFT_APP_TENANT_ID and MICROSOFT_APP_PASSWORD - If you use Teams, follow this guide to create a Teams app for Aster in your organization

Note

For additional configuration options, refer to the .env.example file.

Launch the project:

docker compose up -d

If you prefer to use pre-built images:

docker compose -p aster-quick-start -f docker-compose.quick-start.yml up -d

The quick-start setup automatically creates a demo user you can use to log in:

Field Value
Email linus@aster.so
Password @justForFun1991

Note

For additional information, refer to the seed README. This includes, but is not limited to, instructions on how to enable/disable seed data at startup and how to remove existing seed data (both in local development and Docker containers).

To stop the quick-start containers:

docker compose -p aster-quick-start down

Note

If you are using Microsoft Teams, make sure to uncomment the teamsbot service in docker-compose.quick-start.yml before running the command.

You should now be able to access Aster through http://localhost:5173. Simply create an account with the email you use for Slack or Teams, and set up your organization.

Updates

Pull the latest changes:

git pull

Rebuild images:

docker compose up --build -d

Licensing

There are two editions of Aster:

  • Aster Community Edition (CE) is available freely under the AGPL 3.0 license.
  • Aster Enterprise Edition (EE) includes extra features that are primarily useful for larger organizations. For feature details, check out our website.

About

Open source AI on-call engineer

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors