oncall-engine/docs/sources/open-source.md

aliases	keywords	title	weight
/docs/grafana-cloud/oncall/open-source/ /docs/oncall/latest/open-source/	Open Source	Open Source	300

Grafana OnCall Open Source guide

Grafana OnCall is a developer-friendly incident response tool that's available to Grafana open source and Grafana Cloud users. The OSS version of Grafana OnCall provides the same reliable on-call management solution along with the flexibility of a self-managed environment.

This guide describes the necessary installation and configuration steps needed to configure OSS Grafana OnCall.

The intended audience for this guide includes:

• Grafana open source admins who are responsible for deploying and configuring Grafana OnCall.
• Grafana open source users who need to configure SMS and phone notifications using Grafana Cloud.

Install Grafana OnCall OSS

There are three Grafana OnCall OSS environments available:

• Hobby playground environment for local usage: README.md
• Development environment for contributors: DEVELOPER.md
• Production environment for reliable cloud installation: Production Environment

For detailed installation instructions and additional resources, refer to the OSS Grafana OnCall README.md

For more information on production environment installation, refer to the following OSS Grafana OnCall production environment helm chart

Slack integration for Grafana OnCall OSS

The Slack integration for Grafana OnCall leverages Slack API features to provide a customizable and useful integration.

Before you begin

Review the following requirements to configure Slack for Grafana OnCall OSS:

• Ensure your Grafana OnCall environment is running.
• Grafana OnCall must be externally available and provide HTTPS endpoint to establish subscription on Slack events.
• Create a new Slack App from Grafana OnCall app manifest.

Configure Slack for Grafana OnCall OSS

1. Ensure your Grafana OnCall environment is up and running.

2. Grafana OnCall must be accessible through HTTPS. For development purposes, it's recommend to use localtunnel. For production purposes, consider establishing a proper web server with HTTPS termination. For localtunnel, refer to the following configuration:

# Choose the unique prefix instead of pretty-turkey-83
# Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt
# it is referred as <ONCALL_ENGINE_PUBLIC_URL> below
lt --port 8080 -s pretty-turkey-83 --print-requests

3. If using localtunnel, open your external URL and click Continue to allow requests to bypass the warning page.

4. Create a Slack Workspace for development, or use your company workspace.

5. Go to https://api.slack.com/apps and click Create New App

6. Select From an app manifest option and select your workspace.

7. Copy and paste the following block. Be sure to replace YOUR_BOT_NAME and ONCALL_ENGINE_PUBLIC_URL fields with the appropriate information.

_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: <YOUR_BOT_NAME>
features:
  app_home:
    home_tab_enabled: true
    messages_tab_enabled: true
    messages_tab_read_only_enabled: false
  bot_user:
    display_name: <YOUR_BOT_NAME>
    always_online: true
  shortcuts:
    - name: Create a new incident
      type: message
      callback_id: incident_create
      description: Creates a new OnCall incident
    - name: Add to postmortem
      type: message
      callback_id: add_postmortem
      description: Add this message to postmortem
  slash_commands:
    - command: /oncall
      url: <ONCALL_ENGINE_PUBLIC_URL>/slack/interactive_api_endpoint/
      description: oncall
      should_escape: false
oauth_config:
  redirect_urls:
    - <ONCALL_ENGINE_PUBLIC_URL>/api/internal/v1/complete/slack-install-free/
    - <ONCALL_ENGINE_PUBLIC_URL>/api/internal/v1/complete/slack-login/
  scopes:
    user:
      - channels:read
      - chat:write
      - identify
      - users.profile:read
    bot:
      - app_mentions:read
      - channels:history
      - channels:read
      - chat:write
      - chat:write.customize
      - chat:write.public
      - commands
      - files:write
      - groups:history
      - groups:read
      - im:history
      - im:read
      - im:write
      - mpim:history
      - mpim:read
      - mpim:write
      - reactions:write
      - team:read
      - usergroups:read
      - usergroups:write
      - users.profile:read
      - users:read
      - users:read.email
      - users:write
settings:
  event_subscriptions:
    request_url: <ONCALL_ENGINE_PUBLIC_URL>/slack/event_api_endpoint/
    bot_events:
      - app_home_opened
      - app_mention
      - channel_archive
      - channel_created
      - channel_deleted
      - channel_rename
      - channel_unarchive
      - member_joined_channel
      - message.channels
      - message.im
      - subteam_created
      - subteam_members_changed
      - subteam_updated
      - user_change
  interactivity:
    is_enabled: true
    request_url: <ONCALL_ENGINE_PUBLIC_URL>/slack/interactive_api_endpoint/
  org_deploy_enabled: false
  socket_mode_enabled: false

6. Set environment variables by navigating to your Grafana OnCall, then click Env Variables and set the following:

   SLACK_CLIENT_OAUTH_ID = Basic Information -> App Credentials -> Client ID
   SLACK_CLIENT_OAUTH_SECRET = Basic Information -> App Credentials -> Client Secret
   SLACK_SIGNING_SECRET = Basic Information -> App Credentials -> Signing Secret
   SLACK_INSTALL_RETURN_REDIRECT_HOST = << OnCall external URL >>
   

7. From OnCall, navigate to ChatOps, select Slack and click Install Slack integration.

8. Configure additional Slack settings as needed and your integration is ready for use.

Telegram integration for Grafana OnCall OSS

The Telegram integration for Grafana OnCall is designed for collaborative team work and improved incident response.

Before your begin

Review the following requirements to configure Telegram for Grafana OnCall OSS:

• Ensure your Grafana OnCall environment is running.
• Grafana OnCall must be externally available and provide HTTPS endpoint to establish subscription on Telegram events.
• Create new Telegram Group and private Telegram channel for alerts.

Configure Telegram for Grafana OnCall OSS

1. Ensure your OnCall environment is up and running.

2. Request BotFather for a key, then add your key in TELEGRAM_TOKEN in your Grafana OnCall Env Variables.

3. Set TELEGRAM_WEBHOOK_HOST with your external URL for your Grafana OnCall.

4. From the ChatOps tab in Grafana OnCall, click Telegram and your integration is now ready for use.

Connect Grafana Cloud to Grafana OnCall OSS

Open source Grafana OnCall can be connected to Grafana Cloud to configure a variety of notifications.

The benefits of connecting to Grafana Cloud include:

• Heartbeat notification
• SMS for user notifications
• Phone calls for user notifications.

To connect to Grafana Cloud, refer to the Cloud page in your OSS Grafana OnCall instance.

NOTE: As an alternative option to Grafana Cloud, phone call and SMS notifications can be configured using Twilio.

Connect Twilio for Grafana OnCall OSS

Grafana OnCall supports Twilio SMS and phone call notifications delivery. If you prefer to configure SMS and phone call notifications using Twilio, complete the following steps:

1. Set GRAFANA_CLOUD_NOTIFICATIONS_ENABLED as False to ensure the Grafana OSS <-> Cloud connector is disabled.
2. From your OnCall environment, select Env Variables and configure all variables starting with TWILIO_.