GreenWebhook is a proxy or gateway between two systems that helps reduce your carbon footprint by dynamically routing or delaying traffic so that your workloads run when and where they will cause the lowest amount of carbon emissions.

Last update: Nov 23, 2022

Overview

💚 Welcome to Green Webhook! 💚

Green Webhook is a proxy or gateway between two systems that intelligently chooses which endpoint to send a webhook event to in order to location shift or time shift (coming soon) compute workloads to the endpoint with the lowest carbon intensity. It uses the Carbon Aware SDK to check the impact of an increased demand on the electricity grid for the relevant locations.

By deploying your workload to multiple regions and configuring each endpoint along with its location within a Green Webhook you can reduce the carbon emissions caused by your workload.

Currently Green Webhook supports only Azure regions but as the Carbon Aware SDK adds more support for other locations Green Webhook will be able to support them too.

Green Webhook is built on RedwoodJS and uses:

Create a webhook that runs code on your laptop via ngrok

Create a NextJS app by running npx create-next-app nextjs-blog --use-npm --example "https://github.com/vercel/next-learn/tree/master/basics/api-routes-starter"
Create pages/api/user.js with:

export default function handler(req, res) {
  res.status(200).json({ name: "John Doe" });
}

In a terminal run npm run dev
Install Ngrok
In a terminal run ngrok http 3000
Copy the URL output by Ngrok and add /api/user to the end
Log in to https://greenwebhook.netlify.app and create a new webhook
Paste the URL from step 6 into the destination
Click Save
Click on the Invocation URI link to trigger the webhook
Confirm that the response is 200 and contains JSON { name: "John Doe" }

Currently the Carbon Aware SDK only supports a limited list of locations but when more locations are supported then we will be able to allow you to put in the location where your computer or laptop is running in order to determine if it is the location with the lowest carbon intensity.

Getting started developing locally

Prerequisites

Green Webhook is built with Redwood and requires Node.js (>=14.19.x <=16.x) and Yarn (>=1.15)

Are you on Windows? For best results, follow our Windows development setup guide

Start by installing dependencies:

yarn install

Whilst that is running, create a file in the root folder called .env and copy the following into it:

# Used to encrypt/decrypt session cookies. Change this value and re-deploy to log out all users of your app at once.
# Run yarn redwood generate secret and copy the value below
SESSION_SECRET=YOUR_SESSION_SECRET
# SendInBlue secret for reset password emails to work (optional)
# Requires setting up a free account at https://www.sendinblue.com/
SEND_IN_BLUE_KEY=YOUR_SENDINBLUE_SECRET
# Create a free database via https://railway.app and replace YOUR_RAILWAY_DB_URL bellow with the connection URL
DATABASE_URL="YOUR_RAILWAY_DB_URL"
CARBON_AWARE_API_BASE_URI="https://carbon-aware-api.azurewebsites.net"

Replace YOUR_SESSION_SECRET with the secret generated by running yarn rw generate secret.

Create a free database via https://railway.app and copy the connection URL and replace YOUR_RAILWAY_DB_URL with it

If you want to be able to send emails to reset passwords then you will need to create a SendInBlue account and create an API key and replace SEND_IN_BLUE_KEY with the API key.

Now when yarn install is finished you're ready to create the database tables in your Railway database.

yarn redwood prisma migrate dev

Once this finishes you should see tables appear in the database in Railway

Now you can run the app locally:

yarn rw dev

Your browser should automatically open to http://localhost:8910 where you'll see the Home page.

Frontend first with Storybook

Don't know what your data models look like? That's more than ok — Redwood integrates Storybook so that you can work on design without worrying about data. Mockup, build, and verify your React components, even in complete isolation from the backend:

yarn rw storybook

Comments

Fix create new webhook button

Clicking on the create new green webhook button doesn't do anything.

Possibly there is something wrong in web/src/Routes.tsx but I haven't been able to work out what it is.
bug

opened by jonparker 7
Endpoint decision algorithm
Algorithm for deciding which endpoint to call based on

best avg carbon intensity for expected duration of processing

scheduled in the bounds of provided max delay
opened by mr-loop-1 2
Add time shifting support

In order to support time shifting ( delaying calling the webhook endpoint ) we need to setup scheduled functions in RedwoodJS / Netlify https://docs.netlify.com/functions/scheduled-functions/

Supabase has support ( https://supabase.com/blog/postgres-as-a-cron-server ) but we're currently hosting the database on Railway which has support but requires a few more steps ( https://blog.railway.app/p/cron-jobs )

opened by jonparker 2
add estimate logic

Handles : Estimation should only be done if user has NOT entered an estimatedTime. By default, starting estimate is 5 minutes or 300 sec

also handles: our estimation should not be reflected on webhookForm and user should see a blank field if he didn't provided it

opened by mr-loop-1 1
changed schema to optional

Made the webhook id field in scheduled invocations as optional, so if a webhook is deleted, instead of giving out errors on connected scheduledInvocations it will simply blank the webhookId field.

opened by mr-loop-1 1
Fixed 'Create New Webhook' button

Since Routes.tsx only passes button props in case of ScaffoldLayout only, the DefaultLayout.tsx has been modified to accomodate for the home and about page too.

Fixes #29 and #27

opened by mr-loop-1 1
Implement external auth

Rather than use username and password auth stored in the DB an external provider should be used. Alternatively a magic link in an email could be used for all sessions.

opened by jonparker 0
Create a scheduled invocations page for each webhook
In the /webhooks route, where all webhooks are listed, create a show "schedules" button.

On the new page, list all the schedules available for that webhook and seaprate them into two switchable menus of "scheduled" and "completed" based on the isCompleted boolean present in each element of array

So,

query FindWebhookById($id: String!) { webhook: webhook(id: $id) { id include: { scheduledInvocations: true } } }

could do the trick
opened by mr-loop-1 0
Success confirmation feature

Add a feature that allows for the endpoint to call back to the webhook on some URL to notify that the job or workload has completed. This would enable more analytics of how much carbon emissions were saved by the Green Webhook moving the workload.

Note that this wouldn't give an actual Kg of CO2 measurement as it would take much more work to know how many Killowatts of power the workload consumed.

opened by jonparker 0

GreenWebhook is a proxy or gateway between two systems that helps reduce your carbon footprint by dynamically routing or delaying traffic so that your workloads run when and where they will cause the lowest amount of carbon emissions.

Related tags

Overview

💚 Welcome to Green Webhook! 💚

Create a webhook that runs code on your laptop via ngrok

Getting started developing locally

Frontend first with Storybook

Comments

Fix create new webhook button

Endpoint decision algorithm

Add time shifting support

add estimate logic

changed schema to optional

Fixed 'Create New Webhook' button

Implement external auth

Create a scheduled invocations page for each webhook

Success confirmation feature

Owner

Jonathan Parker

zkPoB is a mobile compatible tool that lets anyone prove they own a Bufficorn (or any NFT) without revealing which Buffi they own or the address they are verifying themselves with

🪐 The IPFS gateway for NFT.Storage is not "another gateway", but a caching layer for NFTs that sits on top of existing IPFS public gateways.

Deploy a multi-account cloud foundation to support highly-regulated workloads and complex compliance requirements.

Polyfill `error.cause`

Zero Two Bot,A fully Modular Whatsapp Bot to do everything possible in WhatsApp by Team Zero Two

The Happy Devs Leaderboard allows users to submit their scores. The app then ranks them from highest scores to the lowest.

to choose the best one of Gcore‘IPs for connection with lowest latency.

Multithread emulator. The wrun allows you to dynamically run a function inside a Web Worker on the client side, without the needing of a dedicated file

Bitloops is Low-Code Workflow Orchestration platform that helps you build backend systems and APIs 10x faster.

A plugin that can find the paths between two notes. Not sure who will want to use it...

Heliaia - a proxy that sits between your wallet and a node🧑‍⚖️

A superfast and easy to use knowledge base to help your customers get the info they need, when they need it most.

mirrord lets you easily mirror traffic from your production environment to your development environment.

Tenzi is a dice game. The player needs to roll dice until they are all the same. Clicking on a dice, freezes it at its current value between rolls. Best scores are saved to local storage.

proxy 🦄 yxorp is your Web Proxy as a Service (SAAS) Multi-tenant, Multi-Threaded, with Cache & Article Spinner

An example web extension, using MockRTC to intercept & debug your own WebRTC traffic

Proxy but misspelled -- closed proxy for the internet