This GitHub Action simplifies setting up a WireGuard connection with wg-quick. It only requires a WireGuard configuration file as input to get your connection up and running quickly.
- Single input - no need for multiple input variables or complex setup!
To use this GitHub Action, follow these steps in your workflow file:
name: Set up WireGuard Tunnel
on:
push:
branches:
- main
jobs:
wireguard:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up WireGuard Tunnel
uses: NeoLabHQ/wireguard-quick-action@v2
with:
WG_CONFIG_FILE: ${{ secrets.WG_CONFIG_FILE }}If your config works with wg-quick, it will work with this action. Provide the file as a secret for the WG_CONFIG_FILE input. The action will set up the connection automatically. When the job finishes, the connection is removed.
This action is based on the work of the original authors of Easy WireGuard Connection.
Many thanks to them for their contributions and for making their code available. Unfortunately, the project had not been maintained for several years and lacked a few minor features, which led us to fork it to address potential supply chain attack vulnerability.