GitHub Action
Netbird connect
v1.0.1
Pre-release
This GitHub Action allows you to connect your workflow to your Netbird network. You can use it to set up a Netbird peer and connect it to your Netbird network.
| Input | Description | Required | Default Value |
|---|---|---|---|
setup-key |
Setup key obtained from the Management Service Dashboard (used to register the peer). | Yes | N/A |
hostname |
Sets a custom hostname that is visible from the Netbird Dashboard. If not provided, a default hostname will be generated. | No | ' ' |
management-url |
This is the URL of the Netbird Management Service. If not provided, a default URL will be used. | No | 'https://api.wiretrustee.com:443' |
args |
Optional additional arguments to pass to the netbird up command. |
No | ' ' |
name: Connect to Netbird
on:
push:
branches:
- main
jobs:
netbird:
name: Connect to Netbird
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v2
- name: Netbird Connect
id: netbird
uses: Alemiz112/netbird-connect@v1
with:
setup-key: ${{ secrets.NETBIRD_SETUP_KEY }}
hostname: 'my-custom-hostname'
management-url: 'https://my-netbird-management-url.com'
args: '--custom-arg value'