https://github.com/zerotier/github-action

A Github Action for ZeroTier
https://github.com/zerotier/github-action

Last synced: about 1 month ago
JSON representation

A Github Action for ZeroTier

• Host: GitHub
• URL: https://github.com/zerotier/github-action
• Owner: zerotier
• License: apache-2.0
• Created: 2022-12-17T08:31:55.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-11T22:35:06.000Z (10 months ago)
• Last Synced: 2024-10-02T20:45:41.812Z (2 months ago)
• Language: JavaScript
• Homepage: https://zerotier.com
• Size: 25.4 KB
• Stars: 46
• Watchers: 11
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-actions - Setup ZeroTier - Connect your runner to a ZeroTier network. (Community Resources / Networking)
• trackawesomelist - Setup ZeroTier (⭐45) - Connect your runner to a ZeroTier network. (Recently Updated / [Sep 02, 2024](/content/2024/09/02/README.md))
• fucking-awesome-actions - Setup ZeroTier - Connect your runner to a ZeroTier network. (Community Resources / Networking)

README

        
# ZeroTier GitHub Action

ZeroTier is an SDN platform that allows users to create virtual

networks that can span multiple devices, locations, and cloud

providers. ZeroTier creates an encrypted peer-to-peer mesh overlay

network that handles NAT traversal and authentication to network

resources.

The ZeroTier Github Action allows users to easily integrate

ZeroTier into their CI/CD workflows by temporarily joining and

authorizing runners onto private ZeroTier networks.

```yaml

- name: ZeroTier

  uses: zerotier/[email protected]

  with:

    network_id: ${{ secrets.ZEROTIER_NETWORK_ID }}

    auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }}

```

`ZEROTIER_CENTRAL_TOKEN` can be provisioned from `Account` section in the [ZeroTier Central](https://my.zerotier.com) admin panel.

This Action works on Ubuntu, MacOS, and Windows runners.

----

This action installs ZeroTier on the runner node and generates a unique ZeroTier identity.  

It then uses the supplied `auth_token` to authorize the runner onto the network.

```yaml

- name: ZeroTier

  uses: zerotier/[email protected]

  with:

    network_id: ${{ secrets.ZEROTIER_NETWORK_ID }}

    auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }}

    

- name: ping host

  shell: bash

  run: |

    count=10

    while ! ping -c 1 ${{ secrets.ZEROTIER_HOST_IP }} ; do

      echo "waiting..." ;

      sleep 1 ;

      let count=count-1

    done

    echo "ping success"

```

After the workflow has completed, a `post` step automatically cleans

up by removing the runner from the network.