Giter VIP home page Giter VIP logo

cf-status-worker's Introduction

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, 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

In Progress Incident

In_Progress Incident

Resolved Incident

Resolved Incident

Setting Up Automated Publishing

You can use the Discord API 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.
  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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.