├── .github └── workflows │ ├── test-tunnel.yaml │ └── test.yaml ├── LICENSE ├── README.md ├── action.yml ├── scripts ├── download │ ├── Unix-like.sh │ └── Windows.ps1 └── version │ ├── Unix-like.sh │ └── Windows.ps1 ├── shutdown └── action.yaml └── tunnel ├── action.yaml └── scripts ├── autostart ├── Unix-like.sh └── Windows.ps1 └── sign-in ├── Unix-like.sh └── Windows.ps1 /.github/workflows/test-tunnel.yaml: -------------------------------------------------------------------------------- 1 | name: Test setup-cloudflared/tunnel 2 | on: 3 | push: 4 | paths: 5 | - tunnel/action.yaml 6 | - tunnel/scripts/** 7 | - shutdown/action.yaml 8 | - .github/workflows/test-tunnel.yaml 9 | 10 | jobs: 11 | test: 12 | runs-on: ${{ matrix.os }} 13 | strategy: 14 | fail-fast: false 15 | matrix: 16 | os: [ubuntu-latest, windows-latest, macos-latest] 17 | type: [production, trycloudflare] 18 | 19 | steps: 20 | - name: Setup cloudflared using setup-cloudflared 21 | uses: AnimMouse/setup-cloudflared@main 22 | 23 | - name: Setup cloudflared tunnel using setup-cloudflared/tunnel 24 | if: matrix.type == 'production' 25 | uses: AnimMouse/setup-cloudflared/tunnel@main 26 | with: 27 | cloudflare_tunnel_credential: ${{ secrets.CLOUDFLARE_TUNNEL_CREDENTIAL }} 28 | cloudflare_tunnel_configuration: ${{ runner.os == 'macOS' && vars.CLOUDFLARE_TUNNEL_CONFIGURATION_MACOS || runner.os == 'Windows' && vars.CLOUDFLARE_TUNNEL_CONFIGURATION_WINDOWS || vars.CLOUDFLARE_TUNNEL_CONFIGURATION_UBUNTU }} 29 | cloudflare_tunnel_id: ${{ vars.CLOUDFLARE_TUNNEL_ID }} 30 | 31 | - name: Setup cloudflared tunnel TryCloudflare using setup-cloudflared/tunnel 32 | if: matrix.type == 'trycloudflare' 33 | uses: AnimMouse/setup-cloudflared/tunnel@main 34 | with: 35 | url: http://localhost:8080 36 | 37 | - name: Test cloudflared tunnel using Python HTTP server for 1 minute on Unix-like 38 | if: runner.os == 'Linux' || runner.os == 'macOS' 39 | run: | 40 | if [ $RUNNER_OS = macOS ] 41 | then 42 | function timeout(){ perl -e 'alarm shift; exec @ARGV' "$@"; } 43 | timeout 60 python3 -m http.server 8080 || true 44 | else 45 | timeout 1m python -m http.server 8080 || true 46 | fi 47 | 48 | - name: Test cloudflared tunnel using Python HTTP server for 1 minute on Windows 49 | if: runner.os == 'Windows' 50 | run: | 51 | $http_server = Start-Process "python" "-m http.server 8080" -PassThru 52 | Wait-Process $http_server.Id -Timeout 60 -ErrorAction Ignore 53 | $http_server.CloseMainWindow() 54 | 55 | - name: Shutdown cloudflared using setup-cloudflared/shutdown 56 | if: '! cancelled()' 57 | uses: AnimMouse/setup-cloudflared/shutdown@main -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: Test setup-cloudflared 2 | on: 3 | push: 4 | paths: 5 | - action.yml 6 | - scripts/** 7 | - .github/workflows/test.yaml 8 | pull_request: 9 | paths: 10 | - action.yml 11 | - scripts/** 12 | - .github/workflows/test.yaml 13 | 14 | jobs: 15 | test: 16 | runs-on: ${{ matrix.os }} 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | os: [ubuntu-latest, windows-latest, macos-latest] 21 | version: [latest, "${{ vars.SPECIFIED_VERSION }}"] # Set the SPECIFIED_VERSION variable to the last previous version in order to pass this test 22 | 23 | steps: 24 | - name: Setup cloudflared using setup-cloudflared 25 | uses: AnimMouse/setup-cloudflared@main 26 | with: 27 | version: ${{ matrix.version }} 28 | 29 | - name: Test cloudflared by checking version 30 | run: cloudflared -v -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Setup cloudflared for GitHub Actions 2 | Setup [Cloudflare Tunnel client](https://github.com/cloudflare/cloudflared) for GitHub Actions. 3 | 4 | This action installs [cloudflared](https://github.com/cloudflare/cloudflared) for use in actions by installing it on tool cache using [AnimMouse/tool-cache](https://github.com/AnimMouse/tool-cache). 5 | 6 | This GitHub action participated in the [GitHub Actions Hackathon 2021](https://dev.to/animmouse/expose-your-web-server-on-github-actions-to-the-internet-using-cloudflare-tunnel-ego), but sadly, it lost. 7 | 8 | Test page for setup-cloudflared: https://setup-cloudflared.44444444.xyz (This will only work when the test action is running.) 9 | 10 | ## Usage 11 | To use `cloudflared`, run this action before `cloudflared`. 12 | 13 | ```yaml 14 | steps: 15 | - name: Setup cloudflared 16 | uses: AnimMouse/setup-cloudflared@v2 17 | 18 | - name: Check cloudflared version 19 | run: cloudflared -v 20 | ``` 21 | 22 | ### Cloudflare Tunnel Usage 23 | Use Cloudflare Tunnel to expose servers running inside GitHub Actions to the Internet. 24 | 25 | 1. Encode the JSON credential in Base64 using this command `base64 -w 0 .json` and paste it to `CLOUDFLARE_TUNNEL_CREDENTIAL` secret. 26 | 2. Inside the config.yaml, set `credentials-file:` to: 27 | 1. Ubuntu: `/home/runner/.cloudflared/.json` 28 | 2. Windows: `C:\Users\runneradmin\.cloudflared\.json` 29 | 3. macOS: `/Users/runner/.cloudflared/.json` 30 | 3. Encode the config.yaml in Base64 using this command `base64 -w 0 config.yaml` and paste it to `CLOUDFLARE_TUNNEL_CONFIGURATION` variable. 31 | 4. Add the Cloudflare Tunnel ID to `CLOUDFLARE_TUNNEL_ID` variable. 32 | 33 | To gracefully shutdown Cloudflare Tunnel after being started in the background, use the `AnimMouse/setup-cloudflared/shutdown` action as composite actions does not support `post:` yet.\ 34 | The `Shutdown Cloudflare Tunnel` action should have `if: '! cancelled()'` so that it will run even if the workflow fails. 35 | 36 | ```yaml 37 | steps: 38 | - name: Setup cloudflared 39 | uses: AnimMouse/setup-cloudflared@v2 40 | 41 | - name: Setup cloudflared tunnel 42 | uses: AnimMouse/setup-cloudflared/tunnel@v2 43 | with: 44 | cloudflare_tunnel_credential: ${{ secrets.CLOUDFLARE_TUNNEL_CREDENTIAL }} 45 | cloudflare_tunnel_configuration: ${{ vars.CLOUDFLARE_TUNNEL_CONFIGURATION }} 46 | cloudflare_tunnel_id: ${{ vars.CLOUDFLARE_TUNNEL_ID }} 47 | 48 | - name: Start Python HTTP server 49 | run: timeout 5m python -m http.server 8080 || true 50 | 51 | - name: Shutdown and view logs of cloudflared 52 | if: '! cancelled()' 53 | uses: AnimMouse/setup-cloudflared/shutdown@v2 54 | ``` 55 | 56 | If you don't want to automatically start Cloudflare Tunnel in the background, set `autostart:` to `false`. 57 | 58 | ```yaml 59 | steps: 60 | - name: Setup cloudflared 61 | uses: AnimMouse/setup-cloudflared@v2 62 | 63 | - name: Setup cloudflared tunnel 64 | uses: AnimMouse/setup-cloudflared/tunnel@v2 65 | with: 66 | cloudflare_tunnel_credential: ${{ secrets.CLOUDFLARE_TUNNEL_CREDENTIAL }} 67 | cloudflare_tunnel_configuration: ${{ vars.CLOUDFLARE_TUNNEL_CONFIGURATION }} 68 | cloudflare_tunnel_id: ${{ vars.CLOUDFLARE_TUNNEL_ID }} 69 | autostart: false 70 | 71 | - name: Manually start cloudflared tunnel 72 | run: timeout 5m cloudflared tunnel run || true 73 | ``` 74 | 75 | ### TryCloudflare Usage 76 | You can use Cloudflare Tunnel without a Cloudflare account and a domain name. Your quick tunnel URL will appear on the Actions log. 77 | 78 | ```yaml 79 | steps: 80 | - name: Setup cloudflared 81 | uses: AnimMouse/setup-cloudflared@v2 82 | 83 | - name: Setup cloudflared tunnel 84 | uses: AnimMouse/setup-cloudflared/tunnel@v2 85 | with: 86 | url: http://localhost:8080 87 | 88 | - name: Start Python HTTP server 89 | run: timeout 5m python -m http.server 8080 || true 90 | 91 | - name: Shutdown and view logs of cloudflared 92 | if: '! cancelled()' 93 | uses: AnimMouse/setup-cloudflared/shutdown@v2 94 | ``` 95 | 96 | ### Specific version 97 | You can specify the version you want. By default, this action downloads the latest version if the version is not specified. 98 | 99 | ```yaml 100 | steps: 101 | - name: Setup cloudflared 102 | uses: AnimMouse/setup-cloudflared@v2 103 | with: 104 | version: 2024.2.1 105 | ``` 106 | 107 | ### GitHub token 108 | This action automatically uses a GitHub token in order to authenticate with the GitHub API and avoid rate limiting. You can also specify your own read-only fine-grained personal access token. 109 | 110 | ```yaml 111 | steps: 112 | - name: Setup cloudflared 113 | uses: AnimMouse/setup-cloudflared@v2 114 | with: 115 | token: ${{ secrets.GH_PAT }} 116 | ``` 117 | 118 | ### Example config.yaml file 119 | Ubuntu: 120 | ```yaml 121 | url: http://localhost:8080 122 | tunnel: deadbeef-1234-4321-abcd-123456789abc 123 | credentials-file: /home/runner/.cloudflared/deadbeef-1234-4321-abcd-123456789abc.json 124 | ``` 125 | 126 | Windows: 127 | ```yaml 128 | url: http://localhost:8080 129 | tunnel: deadbeef-1234-4321-abcd-123456789abc 130 | credentials-file: C:\Users\runneradmin\.cloudflared\deadbeef-1234-4321-abcd-123456789abc.json 131 | ``` 132 | 133 | macOS: 134 | ```yaml 135 | url: http://localhost:8080 136 | tunnel: deadbeef-1234-4321-abcd-123456789abc 137 | credentials-file: /Users/runner/.cloudflared/deadbeef-1234-4321-abcd-123456789abc.json 138 | ``` 139 | 140 | ### Similar actions 141 | 1. [vmactions/cf-tunnel](https://github.com/vmactions/cf-tunnel) 142 | 2. [apogiatzis/ngrok-tunneling-action](https://github.com/apogiatzis/ngrok-tunneling-action) 143 | 3. [vmactions/ngrok-tunnel](https://github.com/vmactions/ngrok-tunnel) -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: Setup cloudflared 2 | description: Setup/Install Cloudflare Tunnel client for GitHub Actions 3 | branding: 4 | icon: cloud 5 | color: orange 6 | inputs: 7 | version: 8 | description: cloudflared version 9 | default: latest 10 | token: 11 | description: GitHub token to avoid API rate limiting 12 | default: ${{ github.token }} 13 | 14 | runs: 15 | using: composite 16 | steps: 17 | - name: Get cloudflared version for Unix-like 18 | id: version-unix-like 19 | if: runner.os == 'Linux' || runner.os == 'macOS' 20 | shell: bash 21 | run: $GITHUB_ACTION_PATH/scripts/version/Unix-like.sh 22 | env: 23 | version: ${{ inputs.version }} 24 | GITHUB_TOKEN: ${{ inputs.token }} 25 | 26 | - name: Get cloudflared version for Windows 27 | id: version-windows 28 | if: runner.os == 'Windows' 29 | shell: pwsh 30 | run: '& $env:GITHUB_ACTION_PATH\scripts\version\Windows.ps1' 31 | env: 32 | version: ${{ inputs.version }} 33 | GITHUB_TOKEN: ${{ inputs.token }} 34 | 35 | - name: Restore cloudflared cache 36 | id: cache 37 | uses: actions/cache/restore@v4 38 | with: 39 | path: ${{ runner.tool_cache }}/cloudflared 40 | key: cloudflared-${{ steps.version-unix-like.outputs.version || steps.version-windows.outputs.version }}-${{ runner.os }} 41 | 42 | - name: Download cloudflared for Unix-like 43 | if: (runner.os == 'Linux' || runner.os == 'macOS') && (! steps.cache.outputs.cache-hit || steps.cache.outputs.cache-hit == 'false') 44 | shell: bash 45 | working-directory: ${{ runner.temp }} 46 | run: $GITHUB_ACTION_PATH/scripts/download/Unix-like.sh 47 | env: 48 | version: ${{ steps.version-unix-like.outputs.version }} 49 | 50 | - name: Download cloudflared for Windows 51 | if: runner.os == 'Windows' && (! steps.cache.outputs.cache-hit || steps.cache.outputs.cache-hit == 'false') 52 | shell: pwsh 53 | working-directory: ${{ runner.temp }} 54 | run: '& $env:GITHUB_ACTION_PATH\scripts\download\Windows.ps1' 55 | env: 56 | version: ${{ steps.version-windows.outputs.version }} 57 | 58 | - name: Install cloudflared on tool cache 59 | uses: AnimMouse/tool-cache@v1 60 | with: 61 | folder_name: cloudflared 62 | cache_hit: ${{ steps.cache.outputs.cache-hit }} 63 | 64 | - name: Save cloudflared cache 65 | if: "! steps.cache.outputs.cache-hit || steps.cache.outputs.cache-hit == 'false'" 66 | uses: actions/cache/save@v4 67 | with: 68 | path: ${{ runner.tool_cache }}/cloudflared 69 | key: cloudflared-${{ steps.version-unix-like.outputs.version || steps.version-windows.outputs.version }}-${{ runner.os }} -------------------------------------------------------------------------------- /scripts/download/Unix-like.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -eu 3 | echo ::group::Downloading cloudflared $version for $RUNNER_OS 4 | mkdir -p cloudflared 5 | if [ $RUNNER_OS = macOS ] 6 | then 7 | wget -qO- $GITHUB_SERVER_URL/cloudflare/cloudflared/releases/download/$version/cloudflared-darwin-amd64.tgz | tar -xz -C cloudflared cloudflared 8 | else 9 | wget -q -O cloudflared/cloudflared $GITHUB_SERVER_URL/cloudflare/cloudflared/releases/download/$version/cloudflared-linux-amd64 10 | chmod +x cloudflared/cloudflared 11 | fi 12 | echo ::endgroup:: -------------------------------------------------------------------------------- /scripts/download/Windows.ps1: -------------------------------------------------------------------------------- 1 | $ErrorActionPreference = 'Stop' 2 | $ProgressPreference = 'SilentlyContinue' 3 | Set-StrictMode -Version Latest 4 | Write-Host ::group::Downloading cloudflared $env:version for Windows 5 | New-Item cloudflared -ItemType Directory -Force 6 | Invoke-WebRequest $env:GITHUB_SERVER_URL/cloudflare/cloudflared/releases/download/$env:version/cloudflared-windows-amd64.exe -OutFile cloudflared\cloudflared.exe 7 | Write-Host ::endgroup:: -------------------------------------------------------------------------------- /scripts/version/Unix-like.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -eu 3 | if [ "$version" = latest ] 4 | then 5 | latest_version=$(gh api repos/cloudflare/cloudflared/releases/latest -q .tag_name) 6 | echo "version=$latest_version" >> $GITHUB_OUTPUT 7 | else 8 | echo "version=$version" >> $GITHUB_OUTPUT 9 | fi -------------------------------------------------------------------------------- /scripts/version/Windows.ps1: -------------------------------------------------------------------------------- 1 | $ErrorActionPreference = 'Stop' 2 | Set-StrictMode -Version Latest 3 | if ($env:version -eq 'latest') { 4 | $latest_version = (gh api repos/cloudflare/cloudflared/releases/latest -q .tag_name) 5 | Add-Content $env:GITHUB_OUTPUT version=$latest_version 6 | } 7 | else { 8 | Add-Content $env:GITHUB_OUTPUT version=$env:version 9 | } -------------------------------------------------------------------------------- /shutdown/action.yaml: -------------------------------------------------------------------------------- 1 | name: Shutdown cloudflared 2 | description: Shutdown Cloudflare Tunnel autostarted by setup-cloudflared 3 | branding: 4 | icon: cloud-off 5 | color: orange 6 | 7 | runs: 8 | using: composite 9 | steps: 10 | - name: Shutdown cloudflared for Unix-like 11 | if: runner.os == 'Linux' || runner.os == 'macOS' 12 | shell: bash 13 | working-directory: ${{ runner.temp }} 14 | run: | 15 | kill $(< cloudflared.pid) 16 | if [ $RUNNER_OS = macOS ]; then lsof -p $(< cloudflared.pid) +r 1 &>/dev/null; else tail --pid=$(< cloudflared.pid) -f /dev/null; fi 17 | 18 | - name: View logs of cloudflared for Unix-like 19 | if: runner.os == 'Linux' || runner.os == 'macOS' 20 | shell: bash 21 | working-directory: ${{ runner.temp }} 22 | run: cat cloudflared.log 23 | 24 | - name: Shutdown cloudflared for Windows 25 | if: runner.os == 'Windows' 26 | shell: pwsh 27 | working-directory: ${{ runner.temp }} 28 | run: | 29 | (Get-Process -Id $(Get-Content cloudflared.pid)).CloseMainWindow() 30 | Wait-Process -Id $(Get-Content cloudflared.pid) 31 | 32 | - name: View logs of cloudflared for Windows 33 | if: runner.os == 'Windows' 34 | shell: pwsh 35 | working-directory: ${{ runner.temp }} 36 | run: Get-Content cloudflared.log -------------------------------------------------------------------------------- /tunnel/action.yaml: -------------------------------------------------------------------------------- 1 | name: Setup cloudflared tunnel 2 | description: Use Cloudflare Tunnel to expose private services to the Internet 3 | branding: 4 | icon: cloud 5 | color: orange 6 | inputs: 7 | cloudflare_tunnel_credential: 8 | description: Cloudflare Tunnel Credential encoded in Base64 (deadbeef-1234-4321-abcd-123456789abc.json) 9 | cloudflare_tunnel_configuration: 10 | description: Cloudflare Tunnel Configuration encoded in Base64 (config.yaml) 11 | cloudflare_tunnel_id: 12 | description: Cloudflare Tunnel ID (deadbeef-1234-4321-abcd-123456789abc) 13 | url: 14 | description: Local web server URL for TryCloudflare 15 | default: false 16 | autostart: 17 | description: Autostart cloudflared tunnel in the background 18 | default: true 19 | 20 | runs: 21 | using: composite 22 | steps: 23 | - name: Sign in to cloudflared tunnel on Unix-like 24 | if: (runner.os == 'Linux' || runner.os == 'macOS') && inputs.url == 'false' 25 | shell: bash 26 | run: $GITHUB_ACTION_PATH/scripts/sign-in/Unix-like.sh 27 | env: 28 | cloudflare_tunnel_credential: ${{ inputs.cloudflare_tunnel_credential }} 29 | cloudflare_tunnel_configuration: ${{ inputs.cloudflare_tunnel_configuration }} 30 | cloudflare_tunnel_id: ${{ inputs.cloudflare_tunnel_id }} 31 | 32 | - name: Sign in to cloudflared tunnel on Windows 33 | if: runner.os == 'Windows' && inputs.url == 'false' 34 | shell: pwsh 35 | run: '& $env:GITHUB_ACTION_PATH\scripts\sign-in\Windows.ps1' 36 | env: 37 | cloudflare_tunnel_credential: ${{ inputs.cloudflare_tunnel_credential }} 38 | cloudflare_tunnel_configuration: ${{ inputs.cloudflare_tunnel_configuration }} 39 | cloudflare_tunnel_id: ${{ inputs.cloudflare_tunnel_id }} 40 | 41 | - name: Start cloudflared tunnel in the background on Unix-like 42 | if: (runner.os == 'Linux' || runner.os == 'macOS') && inputs.autostart != 'false' 43 | shell: bash 44 | run: $GITHUB_ACTION_PATH/scripts/autostart/Unix-like.sh 45 | env: 46 | url: ${{ inputs.url }} 47 | 48 | - name: Start cloudflared tunnel in the background on Windows 49 | if: runner.os == 'Windows' && inputs.autostart != 'false' 50 | shell: pwsh 51 | run: '& $env:GITHUB_ACTION_PATH\scripts\autostart\Windows.ps1' 52 | env: 53 | url: ${{ inputs.url }} -------------------------------------------------------------------------------- /tunnel/scripts/autostart/Unix-like.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -eu 3 | echo ::group::Autostarting cloudflared tunnel 4 | if [ "$url" = false ] 5 | then 6 | nohup cloudflared --pidfile $RUNNER_TEMP/cloudflared.pid --logfile $RUNNER_TEMP/cloudflared.log tunnel run & 7 | else 8 | nohup cloudflared --pidfile $RUNNER_TEMP/cloudflared.pid --logfile $RUNNER_TEMP/cloudflared.log tunnel --url "$url" & 9 | fi 10 | echo ::endgroup:: -------------------------------------------------------------------------------- /tunnel/scripts/autostart/Windows.ps1: -------------------------------------------------------------------------------- 1 | $ErrorActionPreference = 'Stop' 2 | Set-StrictMode -Version Latest 3 | Write-Host ::group::Autostarting cloudflared for Windows 4 | if ($env:url -eq 'false') { 5 | Start-Process "cloudflared" "--pidfile $env:RUNNER_TEMP/cloudflared.pid --logfile $env:RUNNER_TEMP/cloudflared.log tunnel run" 6 | } 7 | else { 8 | Start-Process "cloudflared" "--pidfile $env:RUNNER_TEMP/cloudflared.pid --logfile $env:RUNNER_TEMP/cloudflared.log tunnel --url $env:url" 9 | } 10 | Write-Host ::endgroup:: -------------------------------------------------------------------------------- /tunnel/scripts/sign-in/Unix-like.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -eu 3 | echo ::group::Signing in to Cloudflare Tunnel client 4 | mkdir ~/.cloudflared 5 | echo "$cloudflare_tunnel_credential" | base64 -d > ~/.cloudflared/$cloudflare_tunnel_id.json 6 | echo "$cloudflare_tunnel_configuration" | base64 -d > ~/.cloudflared/config.yaml 7 | echo ::endgroup:: -------------------------------------------------------------------------------- /tunnel/scripts/sign-in/Windows.ps1: -------------------------------------------------------------------------------- 1 | $ErrorActionPreference = 'Stop' 2 | Set-StrictMode -Version Latest 3 | Write-Host ::group::Signing in to Cloudflare Tunnel client 4 | New-Item $env:USERPROFILE\.cloudflared -ItemType Directory -Force 5 | $cloudflare_tunnel_credential = [Convert]::FromBase64String($env:cloudflare_tunnel_credential) 6 | $cloudflare_tunnel_configuration = [Convert]::FromBase64String($env:cloudflare_tunnel_configuration) 7 | [IO.File]::WriteAllBytes("$env:USERPROFILE\.cloudflared\$env:cloudflare_tunnel_id.json", $cloudflare_tunnel_credential) 8 | [IO.File]::WriteAllBytes("$env:USERPROFILE\.cloudflared\config.yaml", $cloudflare_tunnel_configuration) 9 | Write-Host ::endgroup:: --------------------------------------------------------------------------------