CLI Version: 2.8.8
Bring Github Action into your private network. Access nodes/devices from CI workflows.
Connect your GitHub Action runner to your OmniEdge network:
- name: OmniEdge
uses: omniedgeio/github-action@v2
with:
mode: edge
network_id: ${{ secrets.OMNIEDGE_NETWORK_ID }}
security_key: ${{ secrets.OMNIEDGE_SECURITY_KEY }}Run a signaling server in your workflow:
- name: OmniEdge Nucleus
uses: omniedgeio/github-action@v2
with:
mode: nucleus
secret: ${{ secrets.OMNIEDGE_SECRET }}Run both VPN client and signaling server:
- name: OmniEdge Dual
uses: omniedgeio/github-action@v2
with:
mode: dual
network_id: ${{ secrets.OMNIEDGE_NETWORK_ID }}
security_key: ${{ secrets.OMNIEDGE_SECURITY_KEY }}
secret: ${{ secrets.OMNIEDGE_SECRET }}| Input | Description | Required | Default |
|---|---|---|---|
mode |
OmniEdge mode: edge, nucleus, or dual |
No | edge |
network_id |
Network ID (edge/dual) | Yes* | |
security_key |
Security key (edge/dual) | Yes* | |
secret |
Cluster secret (nucleus/dual, min 16 chars) | Yes* | |
port |
UDP port | No | 51820 |
as_exit_node |
Act as exit node | No | false |
exit_node |
Route traffic through exit node IP | No | |
verbose |
Enable debug logging | No | false |
version |
OmniEdge CLI version | No | 2.0.0 |
* Required based on mode
- name: OmniEdge Exit Node
uses: omniedgeio/github-action@v2
with:
mode: edge
network_id: ${{ secrets.OMNIEDGE_NETWORK_ID }}
security_key: ${{ secrets.OMNIEDGE_SECURITY_KEY }}
as_exit_node: true- name: OmniEdge
uses: omniedgeio/github-action@v2
with:
mode: edge
network_id: ${{ secrets.OMNIEDGE_NETWORK_ID }}
security_key: ${{ secrets.OMNIEDGE_SECURITY_KEY }}
exit_node: '10.0.0.1'- Sign up for an OmniEdge account
- Create a network and get your Network ID from the dashboard
- Generate a Security Key from the dashboard
- Add secrets to your GitHub repository:
OMNIEDGE_NETWORK_IDOMNIEDGE_SECURITY_KEYOMNIEDGE_SECRET(for nucleus/dual mode)