Quickstart

Prerequisite

• Your Cloudflare account (free plan is enough, no credit card required)
• Your GitHub account to run Actions to deploy

Setup steps

To setup your own Uptimeflare on Cloudflare:

1. Create an API Token at https://dash.cloudflare.com/profile/api-tokens, using Edit Cloudflare Workers template.

   

   Note: If you're using a new Cloudflare account or you've never used any Workers-related features before, please go to the dashboard and open the Workers menu. Opening the Workers landing page for the first time will silently create a workers.dev subdomain automatically, which is required for the deployment. (issue #13)

2. Create a copy of this repo in your account via clicking Use this template. Optionally make it private if you don't want others to see your monitor definitions. (You may directly include token there).

   

3. Set your Cloudflare API Token in Settings - Secrets and variables - Actions, set a secret whose key is CLOUDFLARE_API_TOKEN and value is the token you obtained in Step 1. Your token will be stored securely by GitHub.

   

4. Edit the uptime.config.ts file (located at the root of YOUR OWN repo) to define your monitors and customize your status page, refer to the docs for a more detailed explanation.

   After editing, Navigate to Actions to see the progress of deployment. When the pipeline succeeds, you should see the status page deployed successfully in your Cloudflare account at Workers & Pages.

   

5. To update or modify your config later, just edit uptime.config.ts again. If your configuration is correct, the pipeline will pick up your changes and apply them to your Cloudflare Pages automatically.