https://github.com/xiaotianxt/bypass-cloudflare-for-github-action
Automatically add the public IP of the GitHub Action runner to Cloudflare's firewall IP Access rules.
https://github.com/xiaotianxt/bypass-cloudflare-for-github-action
cloudflare firewall github-actions
Last synced: 3 months ago
JSON representation
Automatically add the public IP of the GitHub Action runner to Cloudflare's firewall IP Access rules.
- Host: GitHub
- URL: https://github.com/xiaotianxt/bypass-cloudflare-for-github-action
- Owner: xiaotianxt
- Created: 2024-07-18T16:56:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T10:11:03.000Z (6 months ago)
- Last Synced: 2025-01-17T00:32:06.619Z (5 months ago)
- Topics: cloudflare, firewall, github-actions
- Homepage:
- Size: 14.6 KB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Bypass Cloudflare for GitHub Action
Never receive 403 Forbidden from Cloudflare again.
Requests from GitHub Action servers to a Cloudflare proxied host may be blocked by [Cloudflare's Web Application Firewall(WAF)](https://developers.cloudflare.com/support/troubleshooting/http-status-codes/4xx-client-error/) or [Bot Fight Mode](https://developers.cloudflare.com/bots/get-started/free/).
This action automatically adds the public IP of the GitHub Action runner to Cloudflare's firewall [IP Access rules](https://developers.cloudflare.com/waf/tools/ip-access-rules/).
## Features
- Automatically retrieves the public IP of the GitHub Action runner.
- Adds the runner's IP to Cloudflare's firewall access rules.
- Waits for the IP to appear in Cloudflare's access rules.
- Cleans up by removing the IP from Cloudflare's access rules after the job is complete.
## Inputs
| Input | Description | Required |
| ------------ | -------------------------- | -------- |
| `cf_zone_id` | Cloudflare Zone ID | true |
| `cf_api_token` | Cloudflare API Token | true |
## Outputs
| Output | Description |
| --------- | --------------------------------- |
| `rule_id` | The ID of the created access rule |
## Usage
To use this action, create a workflow in your repository's `.github/workflows` directory. Below is an example workflow file:
```yaml
name: Bypass Cloudflare for API Access
on: [push]
jobs:
manage-ip-whitelist:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Bypass Cloudflare for GitHub Action
uses: xiaotianxt/[email protected]
with:
cf_zone_id: ${{ secrets.CF_ZONE_ID }}
cf_api_token: ${{ secrets.CF_API_TOKEN }}
- name: Send request to Cloudflare-protected server
run: curl https://example.com/api
```
## Important Note
This action requires a Cloudflare API Token, not the Global API Key. To create an API token:
1. Log in to the Cloudflare dashboard.
2. Go to "My Profile" > "API Tokens".
3. Click "Create Token".
4. Use the "Edit zone DNS" template or create a custom token with the following permissions:
- Zone > Firewall Services > Edit
- Zone > DNS > Edit (if needed)
5. Set the token to access the specific zone you're working with.
6. Create the token and save it securely.
Remember to add your Cloudflare Zone ID and the new API Token to your GitHub repository secrets as `CF_ZONE_ID` and `CF_API_TOKEN` respectively.