https://github.com/walshydev/cf-status-worker

Cloudflare Worker to monitor the Status Pages for incidents and send notifications to Discord
https://github.com/walshydev/cf-status-worker

cloudflare cloudflare-workers discord hacktoberfest workers

Last synced: about 16 hours ago
JSON representation

Cloudflare Worker to monitor the Status Pages for incidents and send notifications to Discord

• Host: GitHub
• URL: https://github.com/walshydev/cf-status-worker
• Owner: WalshyDev
• License: mit
• Created: 2021-09-02T19:08:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T18:28:26.000Z (5 months ago)
• Last Synced: 2024-12-13T16:53:38.851Z (13 days ago)
• Topics: cloudflare, cloudflare-workers, discord, hacktoberfest, workers
• Language: TypeScript
• Homepage:
• Size: 70.3 KB
• Stars: 51
• Watchers: 3
• Forks: 20
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Status Cloudflare Worker

This Cloudflare Worker is made to monitor a status page for incidents. If there is one, it will post into a Discord server (with optional publishing) and continously update the message with incident updates. This allows you to easily track incidents which may be impacting you right inside of Discord.

Want to see it in action?\

We use this in the [Cloudflare Discord](https://discord.gg/cloudflaredev), come check it out!

## How do I set this up?

There are a few steps to the setup, but it should hopefully be pretty straightforward:

1. Clone the repo

2. Edit `src/config.ts` to set the status URL, name of the webhook, avatar and publish channel

3. Authenticate Wrangler with `npx wrangler login`, or set the `CLOUDFLARE_ACCOUNT_ID` and `CLOUDFLARE_API_TOKEN` environment variables (or put them in `.env`)

4. Put your account ID in `wrangler.toml` (you can get this from `npx wrangler whoami`)

5. Create the KV namespace with `npx wrangler kv:namespace create KV`

6. Put the namespace ID in `wrangler.toml`

7. Add Discord webhook with `npx wrangler secret put DISCORD_WEBHOOK`

   1. (optional) If you want publishing, you'll also need to add a Discord bot token with `npx wrangler secret put DISCORD_TOKEN`

8. Run `npm run publish` :)

## Example

### New Incident

![New Incident](https://user-images.githubusercontent.com/8492901/131903623-352dd6ec-bd7f-470f-9468-4a271c4ddc69.png)

### In Progress Incident

![In_Progress Incident](https://user-images.githubusercontent.com/8492901/131903520-5aabc84d-786a-4fb8-841c-f7efda00e316.png)

### Resolved Incident

![Resolved Incident](https://user-images.githubusercontent.com/8492901/131903522-a4cdc4bd-ad6e-4d1d-b6dd-65950cca9b45.png)

## Setting Up Automated Publishing

You can use the [Discord API](https://discord.com/developers/docs) to automatically publish your webhook alerts to all of your announcement subscribers.

To get setup:

1. Create a new or use a pre-existing [Discord Application](https://discord.com/developers/applications).

2. Make note of your application id listed on the `General Information` page you are brought to. You will need this in step 5 to grant your user the correct permissions.

3. Add a bot to your newly created application by going under `Settings → Bot` and pressing `Add Bot`.

4. Copy your `Bot Token` and insert it into your project with `wrangler secret put DISCORD_TOKEN`, being careful to not expose it anywhere else.

5. We now need to add your bot user to the server. Using this feature requires your bot to have the `SEND_MESSAGES` and `MANAGE_MESSAGES` permission, so we will need to grant them those permissions. Take the application id you noted in step 2, replacing the application id below and visiting the link in your browser.

```

https://discord.com/oauth2/authorize?client_id=INSERT-APPLICATION-ID&scope=bot&permissions=10240

```