workers-git-gateway v0.2.0

wokers-git-gateway

This Cloudflare Pages Plugin provides a bare bones implementation of the Netlify Git Gateway for use by DecapCMS.

Installation

npm install workers-git-gateway

Authentication/Security

As this plugin provides no authentication, you must ensure your CMS path (eg /admin) and the path used for the git gateway (ie /.netlify) are protected by Cloudflare Access/Cloudflare Zero Trust.

If you do not do this then you are essentially providing unrestricted access to any repository the provided GitHub Access Token can read/write.

Usage

Create a [[path]].ts file at /functions/.netlify as follows:

import gitGatewayPlugin from "workers-git-gateway"

interface Env {
    GH_ACCESS_TOKEN: string
    GH_REPO: string
}

export const onRequest: PagesFunction<Env> = (context) => {
    return gitGatewayPlugin({
        repo: context.env.GH_REPO,
        token: context.env.GH_ACCESS_TOKEN,
    })(context)
}

In addition you should ensure the /admin path is protected by Cloudflare Access under the same Application.

Add environment variables

You must add the relevant variables to your Cloudflare Pages project that match the names referenced in your code (see above).

Important!

Note: Once again, the plugin does not perform any authentication of the requests it receives as it is assumes the requests are secured "upstream" via Cloudflare Access/Cloudflare Zero Trust.