https://github.com/xjonathanlei/cf-workers-site-template

A CI/CD-optimized Cloudflare Workers template for serving static sites
https://github.com/xjonathanlei/cf-workers-site-template

cloudflare cloudflare-workers ddos-protection single-page-applications

Last synced: 3 months ago
JSON representation

A CI/CD-optimized Cloudflare Workers template for serving static sites

• Host: GitHub
• URL: https://github.com/xjonathanlei/cf-workers-site-template
• Owner: xJonathanLEI
• License: mit
• Created: 2021-03-03T15:27:00.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-18T21:15:40.000Z (about 3 years ago)
• Last Synced: 2023-03-04T00:44:10.251Z (almost 2 years ago)
• Topics: cloudflare, cloudflare-workers, ddos-protection, single-page-applications
• Language: TypeScript
• Homepage:
• Size: 68.4 KB
• Stars: 1
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cloudflare Workers Site Template

This repository contains a CI/CD-optimized Cloudflare Workers template written in TypeScript for serving static sites. It allows certain routes to be proxied so that all requests can be served under the same subdomain, and therefore avoids [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) issues and benefits from Cloudflare's ["under attack"](https://support.cloudflare.com/hc/en-us/articles/200170076-Understanding-Cloudflare-Under-Attack-mode-advanced-DDOS-protection-) DDoS protection mode.

The template is optimized for single page applications. Whenever a request hits a route where an asset cannot be found, a fallback to `index.html` is sent instead of a `404` error.

## Usage

The template is designed to be used by CI/CD pipelines. Such a pipeline shall first transform the website into static files, for example with a Webpack build; then it should clone this repository and replace content in the `public` folder with static files to be served.

Then, authenticate with cloudflare with the following command:

```sh

$ echo "${CLOUDFLARE_API_TOKEN}" | yarn wrangler config

```

Set the following environment variables:

- `CLOUDFLARE_WORKER_NAME`

  Name of the Cloudflare worker.

- `CLOUDFLARE_ACCOUNT_ID`

  Cloudflare account ID.

- `DOMAIN`

  Custom domain to be used for serving the website.

- `CLOUDFLARE_ZONE_ID`

  Cloudflare zone ID of the custom domain.

Finally, publish the site with:

```

$ yarn run publish

```

## Route-based Request Proxying

The worker can be configured to proxy requests to certain routes to other URLs, and thus avoiding cross-origin issues that arise when using Cloudflare's "under attack" DDoS protection mode. Simply replace the file `./src/external/proxies.json` with a JSON-formatted list of proxy rules. For example:

```json

[

  {

    "prefix": "/api/",

    "target": "https://api.example.com/"

  }

]

```

In the example configuration above, assuming the worker is served at `https://example.com/`, a request to `https://example.com/api/login` will be proxied to `https://api.example.com/login`, for instance.

## License

[MIT](./LICENSE)