DEV Community: Anim Mouse

Expose your web server on GitHub Actions to the internet using Cloudflare Tunnel

Anim Mouse — Thu, 09 Dec 2021 04:45:06 +0000

My Workflow

GitHub Actions runners are firewalled from the internet, so you can't test your web server outside of the runners. What if you need to test your web server on GitHub Actions interactively?

This GitHub Action installs the cloudflared Cloudflare Tunnel client and allows you to tunnel connections so that you can now access your server inside the GitHub Actions runners to the internet.

This is an example workflow that tunnels the Python Simple HTTP server so that it is accessible over the internet.

name: Test setup-cloudflared
on:
  push:
    paths:
      - .github/workflows/test.yml

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Setup cloudflared using setup-cloudflared
        uses: AnimMouse/setup-cloudflared@v1
        with:
          cloudflare_tunnel_certificate: ${{ secrets.CLOUDFLARE_TUNNEL_CERTIFICATE }}
          cloudflare_tunnel_credential: ${{ secrets.CLOUDFLARE_TUNNEL_CREDENTIAL }}
          cloudflare_tunnel_configuration: ${{ secrets.CLOUDFLARE_TUNNEL_CONFIGURATION }}
          cloudflare_tunnel_id: ${{ secrets.CLOUDFLARE_TUNNEL_ID }}

      - name: Test cloudflared installed by setup-cloudflared using Python HTTP server for 5 minutes
        run: timeout 5m python -m http.server 8000 || true

      - name: Shutdown cloudflared using setup-cloudflared/shutdown
        if: always()
        uses: AnimMouse/setup-cloudflared/shutdown@v1

Submission Category:

Maintainer Must-Haves

Yaml File or Link to Code

name: Setup cloudflared
description: Setup/Install Cloudflare Tunnel client for GitHub Actions
branding:
  icon: cloud
  color: orange
inputs:
  cloudflare_tunnel_certificate:
    description: Cloudflare Tunnel Certificate (cert.pem)
    required: true
  cloudflare_tunnel_credential:
    description: Cloudflare Tunnel Credential encoded in base64 (deadbeef-1234-4321-abcd-123456789ab.json)
    required: true
  cloudflare_tunnel_configuration:
    description: Cloudflare Tunnel Configuration encoded in base64 (config.yml)
    required: true
  cloudflare_tunnel_id:
    description: Cloudflare Tunnel ID (deadbeef-1234-4321-abcd-123456789ab)
    required: true
  autostart:
    description: Autostart Cloudflare Tunnel
    required: false
    default: true

runs:
  using: composite
  steps:
    - name: Download cloudflared for Linux
      shell: bash
      working-directory: ${{ runner.temp }}
      run: aria2c -x 16 "https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64"

    - name: Install cloudflared
      shell: bash
      working-directory: ${{ runner.temp }}
      run: |
        chmod +x cloudflared-linux-amd64
        mv cloudflared-linux-amd64 /usr/local/bin/cloudflared

    - name: Login to Cloudflare Tunnel client
      shell: bash
      env:
        cloudflare_tunnel_certificate: ${{ inputs.cloudflare_tunnel_certificate }}
        cloudflare_tunnel_credential: ${{ inputs.cloudflare_tunnel_credential }}
        cloudflare_tunnel_configuration: ${{ inputs.cloudflare_tunnel_configuration }}
        cloudflare_tunnel_id: ${{ inputs.cloudflare_tunnel_id }}
      run: |
        mkdir ~/.cloudflared/
        echo $cloudflare_tunnel_certificate > ~/.cloudflared/cert.pem
        echo $cloudflare_tunnel_credential | base64 -d > ~/.cloudflared/${cloudflare_tunnel_id}.json
        echo $cloudflare_tunnel_configuration | base64 -d > ~/.cloudflared/config.yml

    - name: Run Cloudflare Tunnel
      if: inputs.autostart == 'true'
      shell: bash
      env:
        cloudflare_tunnel_id: ${{ inputs.cloudflare_tunnel_id }}
      run: |
        nohup cloudflared tunnel run > ${RUNNER_TEMP}/cloudflared.log 2>&1 &
        echo $! > ${RUNNER_TEMP}/cloudflared.pid

Setup cloudflared for GitHub Actions

Setup Cloudflare Tunnel client for GitHub Actions.

This action installs cloudflared for use in actions by installing it on tool cache using AnimMouse/tool-cache.

This GitHub action participated in the GitHub Actions Hackathon 2021, but sadly, it lost.

Test page for setup-cloudflared: https://setup-cloudflared.44444444.xyz (This will only work when the test action is running.)

Usage

To use cloudflared, run this action before cloudflared.

steps:
  - name: Setup cloudflared
    uses: AnimMouse/setup-cloudflared@v2
    
  - name: Check cloudflared version
    run: cloudflared -v

Cloudflare Tunnel Usage

Use Cloudflare Tunnel to expose servers running inside GitHub Actions to the Internet.

Encode the JSON credential in Base64 using this command base64 -w 0 <cloudflare-tunnel-id>.json and paste it to CLOUDFLARE_TUNNEL_CREDENTIAL secret.
Inside the config.yaml, set credentials-file: to
1. Ubuntu: /home/runner/.cloudflared/<cloudflare-tunnel-id>.json
2. Windows: C:\Users\runneradmin\.cloudflared\<cloudflare-tunnel-id>.json
3. macOS: /Users/runner/.cloudflared/<cloudflare-tunnel-id>.json
Encode the config.yaml in Base64 using this command base64 -w 0 config.yaml and…

View on GitHub

Additional Resources / Info

Cloudflare Tunnel client

Contains the command-line client for Cloudflare Tunnel, a tunneling daemon that proxies traffic from the Cloudflare network to your origins This daemon sits between Cloudflare network and your origin (e.g. a webserver). Cloudflare attracts client requests and sends them to you via this daemon, without requiring you to poke holes on your firewall --- your origin can remain as closed as possible Extensive documentation can be found in the Cloudflare Tunnel section of the Cloudflare Docs. All usages related with proxying to your origins are available under cloudflared tunnel help.

You can also use cloudflared to access Tunnel origins (that are protected with cloudflared tunnel) for TCP traffic at Layer 4 (i.e., not HTTP/websocket), which is relevant for use cases such as SSH, RDP, etc. Such usages are available under cloudflared access help.

You can instead use WARP client to access private origins behind…

View on GitHub

Used by:

AnimMouse / SOCKS5-proxy-actions

SOCKS5 proxy running on GitHub Actions using Chisel

SOCKS5 Proxy Actions

SOCKS5 Proxy hosted on GitHub Actions.

Proof of concept Chisel's SOCKS5 Proxy running on GitHub Actions.

As GitHub Actions runner does not have a public IP address, we use Cloudflare Tunnel to have a tunnel to GitHub Actions runner.

This GitHub action participated on GitHub Actions Hackathon 2021, but sadly, it lost.

Your Computer > Cloudflare > GitHub Actions runner > GitHub Actions' Internet

Deprecation

This workflow is deprecated as this may potentially violate the GitHub Actions Terms of Service, please use AnimMouse/SOCKS5-Proxy-Codespaces instead.

Actions should not be used for:

cryptomining;

disrupting, gaining, or attempting to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the GitHub Bug Bounty program);

the provision of a stand-alone or integrated application or service offering the Actions product or service, or any elements of the Actions product or service, for commercial purposes;

…

View on GitHub

Hosting a SOCKS5 Proxy on GitHub Actions

Anim Mouse — Sun, 05 Dec 2021 16:47:53 +0000

My Workflow

Since GitHub Actions is an IaaS, and Actions Hackathon 2021 allows Wacky Wildcards, I wonder if I can use it as a proxy and view the internet from the perspective of GitHub's servers. So I created a proof of concept SOCKS5 proxy hosted on GitHub Actions.

As GitHub Actions runners are firewalled from incoming connections, what I did is connect to it through Cloudflare Tunnel. And as Cloudflare Tunnel can't tunnel TCP connections (we can use Ngrok but that's for another story), we tunnel SOCKS5 through websockets using Chisel.

Here you can see that I'm browsing the internet using Microsoft's IP address.

Here you can see a speed test from my 45 mbps internet connection.

This action can also be used as a VPN.

Submission Category:

Wacky Wildcards

Yaml File or Link to Code

name: Host Chisel SOCKS5 Proxy
on:
  workflow_dispatch:
    inputs:
      time-duration:
        description: Time to run chisel
        required: true
        default: 10m

jobs:
  socks5-proxy:
    runs-on: ubuntu-latest
    steps:
      - name: Install chisel
        working-directory: ${{ runner.temp }}
        env:
          version: 1.7.6
        run: |
          aria2c -x 16 "https://github.com/jpillora/chisel/releases/latest/download/chisel_${version}_linux_amd64.gz"
          gzip -d chisel_${version}_linux_amd64.gz
          mv chisel_${version}_linux_amd64 /usr/local/bin/chisel
          chmod +x /usr/local/bin/chisel

      - name: Setup Cloudflare Tunnel client
        uses: AnimMouse/setup-cloudflared@v1
        with:
          cloudflare_tunnel_certificate: ${{ secrets.CLOUDFLARE_TUNNEL_CERTIFICATE }}
          cloudflare_tunnel_credential: ${{ secrets.CLOUDFLARE_TUNNEL_CREDENTIAL }}
          cloudflare_tunnel_configuration: ${{ secrets.CLOUDFLARE_TUNNEL_CONFIGURATION }}
          cloudflare_tunnel_id: ${{ secrets.CLOUDFLARE_TUNNEL_ID }}

      - name: Run chisel
        run: timeout "${{ github.event.inputs.time-duration }}" chisel server --socks5 || true

      - name: Shutdown and view logs of Cloudflare Tunnel
        if: always()
        uses: AnimMouse/setup-cloudflared/shutdown@v1

AnimMouse / SOCKS5-proxy-actions

SOCKS5 proxy running on GitHub Actions using Chisel

SOCKS5 Proxy Actions

SOCKS5 Proxy hosted on GitHub Actions.

Proof of concept Chisel's SOCKS5 Proxy running on GitHub Actions.

As GitHub Actions runner does not have a public IP address, we use Cloudflare Tunnel to have a tunnel to GitHub Actions runner.

This GitHub action participated on GitHub Actions Hackathon 2021, but sadly, it lost.

Your Computer > Cloudflare > GitHub Actions runner > GitHub Actions' Internet

Deprecation

This workflow is deprecated as this may potentially violate the GitHub Actions Terms of Service, please use AnimMouse/SOCKS5-Proxy-Codespaces instead.

Actions should not be used for:

cryptomining;

disrupting, gaining, or attempting to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the GitHub Bug Bounty program);

the provision of a stand-alone or integrated application or service offering the Actions product or service, or any elements of the Actions product or service, for commercial purposes;

…

View on GitHub

Additional Resources / Info

AnimMouse / setup-cloudflared

Setup/Install Cloudflare Tunnel client for GitHub Actions

Setup cloudflared for GitHub Actions

Setup Cloudflare Tunnel client for GitHub Actions.

This action installs cloudflared for use in actions by installing it on tool cache using AnimMouse/tool-cache.

This GitHub action participated in the GitHub Actions Hackathon 2021, but sadly, it lost.

Test page for setup-cloudflared: https://setup-cloudflared.44444444.xyz (This will only work when the test action is running.)

Usage

To use cloudflared, run this action before cloudflared.

steps:
  - name: Setup cloudflared
    uses: AnimMouse/setup-cloudflared@v2
    
  - name: Check cloudflared version
    run: cloudflared -v

Cloudflare Tunnel Usage

Use Cloudflare Tunnel to expose servers running inside GitHub Actions to the Internet.

Encode the JSON credential in Base64 using this command base64 -w 0 <cloudflare-tunnel-id>.json and paste it to CLOUDFLARE_TUNNEL_CREDENTIAL secret.
Inside the config.yaml, set credentials-file: to
1. Ubuntu: /home/runner/.cloudflared/<cloudflare-tunnel-id>.json
2. Windows: C:\Users\runneradmin\.cloudflared\<cloudflare-tunnel-id>.json
3. macOS: /Users/runner/.cloudflared/<cloudflare-tunnel-id>.json
Encode the config.yaml in Base64 using this command base64 -w 0 config.yaml and…

View on GitHub

jpillora / chisel

A fast TCP/UDP tunnel over HTTP

Chisel

Chisel is a fast TCP/UDP tunnel, transported over HTTP, secured via SSH. Single executable including both client and server. Written in Go (golang). Chisel is mainly useful for passing through firewalls, though it can also be used to provide a secure endpoint into your network.

Features

Easy to use
Performant*
Encrypted connections using the SSH protocol (via crypto/ssh)
Authenticated connections; authenticated client connections with a users config file, authenticated server connections with fingerprint matching.
Client auto-reconnects with exponential backoff
Clients can create multiple tunnel endpoints over one TCP connection
Clients can optionally pass through SOCKS or HTTP CONNECT proxies
Reverse port forwarding (Connections go through the server and out the client)
Server optionally doubles as a reverse proxy
Server optionally allows SOCKS5 connections (See guide below)
Clients optionally allow SOCKS5 connections from a reversed port…

View on GitHub

Convert direct download links into Torrent using GitHub Actions

Anim Mouse — Sat, 04 Dec 2021 17:36:59 +0000

My Workflow

Back in the day, we have BurnBit that allows us to leverage the P2P power of BitTorrent for our files hosted on our web servers. BurnBit downloads the file in their servers and creates a .torrent metadata of the file and adds your web server as an HTTP webseed for that torrent. This works flawlessly, your file is getting downloaded from your server and at the same time, with other peers already downloaded the file through seeding. This saves bandwidth on your web server, costing you less, and improves the download experience of your users if your web server can't handle the load.

Fast-forward today, BurnBit got down, and there are no alternatives until URLHash, but URLHash has limits, and sometimes goes down.

This GitHub Action workflow allows you to create .torrent file from a direct HTTP link of your web sever and uses that link for webseeding.

This will download the file from your HTTP link and hash it using a torrent creator program using GitHub Actions.

Submission Category:

Wacky Wildcards

Yaml File or Link to Code



name: torrenttools
on:
  workflow_dispatch:
    inputs:
      name:
        description: Name of the torrent file
        required: true
        default: Firefox Setup 94.0.2
      comment:
        description: Comment
        required: true
        default: Firefox Setup 94.0.2 win64 en-US by torrent-webseed-creator
      url:
        description: URL of the file
        required: true
        default: 'https://download-installer.cdn.mozilla.net/pub/firefox/releases/94.0.2/win64/en-US/Firefox%20Setup%2094.0.2.exe'
      file_name:
        description: File name of the file in the torrent
        required: true
        default: Firefox Setup 94.0.2.exe
      piece_size:
        description: Piece Size. Use auto for automatic calculation, or use the recommended piece size on the README.md file
        required: true
        default: auto
      protocol_version:
        description: BitTorrent Protocol version 1, 2, or hybrid
        required: true
        default: '1'
      maximize_disk_space:
        description: Maximize disk space. Set to true if getting out of disk space error
        default: 'false'

jobs:
  create_torrent:
    runs-on: ubuntu-latest
    steps:
      - name: Maximize disk space
        if: ${{ github.event.inputs.maximize_disk_space == 'true' }}
        uses: easimon/maximize-build-space@v4
        with:
          remove-dotnet: 'true'
          remove-android: 'true'
          remove-haskell: 'true'

      - name: Install torrenttools
        run: |
          sudo add-apt-repository ppa:fbdtemme/torrenttools
          sudo apt-get update
          sudo apt-get install torrenttools

      - name: Download file
        run: aria2c -x 16 -o "${{ github.event.inputs.file_name }}" "${{ github.event.inputs.url }}"

      - name: Create torrent using torrenttools
        run: torrenttools create -v "${{ github.event.inputs.protocol_version }}" -o "${{ github.event.inputs.name }}.torrent" -w "${{ github.event.inputs.url }}" -c "${{ github.event.inputs.comment }}" -l "${{ github.event.inputs.piece_size }}" -s "torrent-webseed-creator" "${{ github.event.inputs.file_name }}"

      - name: Upload torrent file
        uses: actions/upload-artifact@v2
        with:
          name: ${{ github.event.inputs.name }}
          path: ${{ github.event.inputs.name }}.torrent

AnimMouse / torrent-webseed-creator

Webseeded torrent creator using GitHub Actions

Torrent Webseed Creator

Webseeded Torrent Creator using GitHub Actions.

Inspired by BurnBit † and URLHash.

An alternative to BurnBit and URLHash.

Convert direct HTTP link to .torrent

Your file is then burned into a torrent.

Torrents created are trackerless, relying on Distributed Hash Table and Peer EXchange, to help reduce the burden of torrent trackers.

For people that have unstable internet.
Can be paused because it is a torrent.
Utilizes the power of peer to peer downloads and the client-server downloads.
Combines the best of both worlds (P2P and Direct HTTP Link).

How to use

Create a repository on GitHub using this template by clicking "Use this template" and then click "Create a new repository".
Go to the Actions tab.
Choose a program to use by clicking the name of the program under "All workflows"…

View on GitHub

Additional Resources / Info

fbdtemme / torrenttools

Commandline tool for inspecting, creating and editing BitTorrent metafiles.

A commandline tool for creating, inspecting and modifying bittorrent metafiles.

Features | Documentation | Binary releases | Building | License

Features

Creating bittorrent metafiles.
Inspecting bittorrent metafiles.
Verifying bittorrent metafiles against local data.
Editing existing bittorrent metafiles.
Support for the new v2 and hybrid protocols .
Support for tracker abbreviations.
Support for announce substitution parameters.
Fast multi-buffer hashing with Intel ISA-L.

Example

Status

This project is under development. The commandline interface can change at any release prior to 1.0.0.

Performance

Following test were performed on a in in-memory filesystem with 1 MiB piece size and as target a file filed with random data totalling 15.0 GiB: The tested CPU is an Intel i7-7700HQ in a Dell XPS 15-9560 machine.

Documentation

Documentation is hosted on Github Pages.

Binary releases

Windows
macOS
Linux
- Fedora
- CentOS
- Ubuntu
- Debian
- Ubuntu
- OpenSUSE
- SUSE Linux Enterprise Server
- Arch
- AppImage
Docker

Windows

An .msi installer…

View on GitHub

Burnbit Turns Any Web-Hosted File into a Torrent Article
Burn Any Web-Hosted File into a Torrent With Burnbit Article

Test

Anim Mouse — Wed, 01 Dec 2021 15:07:32 +0000

Hello World

DEV Community: Anim Mouse

Expose your web server on GitHub Actions to the internet using Cloudflare Tunnel

My Workflow

Submission Category:

Yaml File or Link to Code

AnimMouse / setup-cloudflared

Setup/Install Cloudflare Tunnel client for GitHub Actions

Setup cloudflared for GitHub Actions

Usage

Cloudflare Tunnel Usage

Additional Resources / Info

cloudflare / cloudflared

Cloudflare Tunnel client (formerly Argo Tunnel)

Cloudflare Tunnel client

AnimMouse / SOCKS5-proxy-actions

SOCKS5 proxy running on GitHub Actions using Chisel

SOCKS5 Proxy Actions

Deprecation

Hosting a SOCKS5 Proxy on GitHub Actions

My Workflow

Submission Category:

Yaml File or Link to Code

AnimMouse / SOCKS5-proxy-actions

SOCKS5 proxy running on GitHub Actions using Chisel

SOCKS5 Proxy Actions

Deprecation

Additional Resources / Info

AnimMouse / setup-cloudflared

Setup/Install Cloudflare Tunnel client for GitHub Actions

Setup cloudflared for GitHub Actions

Usage

Cloudflare Tunnel Usage

jpillora / chisel

A fast TCP/UDP tunnel over HTTP

Chisel

Table of Contents

Features

Convert direct download links into Torrent using GitHub Actions

My Workflow

Submission Category:

Yaml File or Link to Code

AnimMouse / torrent-webseed-creator

Webseeded torrent creator using GitHub Actions

Torrent Webseed Creator

How to use

Additional Resources / Info

fbdtemme / torrenttools

Commandline tool for inspecting, creating and editing BitTorrent metafiles.

Features

Example

Status

Performance

Documentation

Binary releases

Contents

Windows

Test