.upptimerc.yml Reference

Complete configuration reference for the .upptimerc.yml file

The .upptimerc.yml file is the main configuration file for your Upptime setup. It defines which sites to monitor, how to display your status page, and various other settings.

Basic Structure

Every Upptime repository needs a .upptimerc.yml file in the root directory. Here’s a minimal example:

owner: your-username
repo: upptime

sites:
  - name: Google
    url: https://www.google.com

status-website:
  cname: demo.upptime.js.org

Required Configuration

owner · string · required

Your GitHub organization or username where the Upptime repository lives.

owner: upptime

repo · string · required

The name of your Upptime repository.

repo: upptime

sites · array · required

An array of sites to monitor. Each site requires a name and url at minimum. See Sites Configuration for detailed options.

sites:
  - name: Google
    url: https://www.google.com
  - name: Wikipedia
    url: https://en.wikipedia.org

Status Website Configuration

status-website · object

Configuration for your status page appearance and behavior.

Show Status Website Options

cname · string

Your custom domain name for the status page. Remove this if you don’t have a custom domain.

status-website:
  cname: demo.upptime.js.org

baseUrl · string

The base URL path for your status page. Use this if you don’t have a custom domain and are hosting on GitHub Pages.

status-website:
  baseUrl: /your-repo-name

logoUrl · string

URL to your logo image. Can be an absolute URL or a relative path.

status-website:
  logoUrl: https://raw.githubusercontent.com/upptime/upptime.js.org/master/static/img/icon.svg

name · string

The name of your status page that appears in the header.

status-website:
  name: Upptime

introTitle · string

The main title text on your status page. Supports markdown formatting.

status-website:
  introTitle: "**Upptime** is the open-source uptime monitor and status page"

introMessage · string

A message displayed below the intro title. Supports markdown formatting.

status-website:
  introMessage: This is a sample status page which uses **real-time** data from our GitHub repository.

navbar · array

Navigation links to display in the navbar.

status-website:
  navbar:
    - title: Status
      href: /
    - title: GitHub
      href: https://github.com/$OWNER/$REPO

Use $OWNER and $REPO as variables that will be replaced with your configuration values.

theme · string · default: "light"

The color theme for your status page. Options: light, dark, night, or ocean.

status-website:
  theme: dark

Notification Settings

assignees · array

GitHub usernames to assign to issues when a site goes down.

assignees:
  - AnandChowdhary
  - yourUsername

notifications · array

Configure notifications for when sites go down or come back up.

Show Notification Options

slack · object

Slack webhook configuration.

notifications:
  - slack:
      webhookUrl: $SLACK_WEBHOOK_URL

discord · object

Discord webhook configuration.

notifications:
  - discord:
      webhookUrl: $DISCORD_WEBHOOK_URL

telegram · object

Telegram bot configuration.

notifications:
  - telegram:
      botToken: $TELEGRAM_BOT_TOKEN
      chatId: $TELEGRAM_CHAT_ID

Monitoring Settings

skipDescriptionUpdate · boolean · default: "false"

Skip updating the commit descriptions when recording uptime data.

skipDescriptionUpdate: true

skipTopicsUpdate · boolean · default: "false"

Skip updating repository topics.

skipTopicsUpdate: true

skipHomepageUpdate · boolean · default: "false"

Skip updating the repository homepage URL.

skipHomepageUpdate: true

skipDeleteIssues · boolean · default: "false"

Don’t delete old issues when they’re closed.

skipDeleteIssues: true

commitMessages · object

Customize commit messages for different operations.

commitMessages:
  readmeContent: ":pencil: Update summary in README [skip ci]"
  summaryJson: ":card_file_box: Update status summary [skip ci]"
  statusChange: "$EMOJI $SITE_NAME is $STATUS ($RESPONSE_CODE in $RESPONSE_TIME ms)"
  graphsUpdate: ":bento: Update graphs [skip ci]"

user-agent · string

Custom user agent string for HTTP requests.

user-agent: "MyUptimeBot/1.0"

delay · number · default: "0"

Delay between checks in milliseconds.

delay: 1000

maxRedirects · number · default: "5"

Maximum number of redirects to follow.

maxRedirects: 3

Example Configuration

Here’s a complete example with common options:

owner: upptime
repo: upptime

sites:
  - name: Google
    url: https://www.google.com
  - name: Wikipedia
    url: https://en.wikipedia.org
  - name: Hacker News
    url: https://news.ycombinator.com

status-website:
  cname: demo.upptime.js.org
  logoUrl: https://raw.githubusercontent.com/upptime/upptime.js.org/master/static/img/icon.svg
  name: Upptime
  introTitle: "**Upptime** is the open-source uptime monitor and status page, powered entirely by GitHub."
  introMessage: This is a sample status page which uses **real-time** data from our [GitHub repository](https://github.com/upptime/upptime).
  navbar:
    - title: Status
      href: /
    - title: GitHub
      href: https://github.com/$OWNER/$REPO
  theme: light

assignees:
  - AnandChowdhary

delay: 1000
maxRedirects: 5

Next Steps

Configure Sites

Learn how to configure different types of site monitoring

Customize Status Page

Customize the look and feel of your status page

Workflows

Understand GitHub Actions workflows