https://github.com/eonx-com/setup-wireguard

https://github.com/eonx-com/setup-wireguard

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/eonx-com/setup-wireguard
• Owner: eonx-com
• License: mit
• Created: 2022-09-16T01:29:29.000Z (almost 4 years ago)
• Default Branch: release
• Last Pushed: 2023-05-18T20:33:45.000Z (about 3 years ago)
• Last Synced: 2025-05-18T07:38:59.604Z (about 1 year ago)
• Size: 4.88 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Set up WireGuard

================

[![Test](https://github.com/egor-tensin/setup-wireguard/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/setup-wireguard/actions/workflows/test.yml)

This GitHub action sets up a WireGuard connection in your workflow run.

1. Installs WireGuard if it's missing.

2. Sets up a connection using the provided credentials.

Use it your workflow like this:

    - name: Set up WireGuard

      uses: egor-tensin/setup-wireguard@v1

      with:

        endpoint: 46.46.46.46:51820

        endpoint_public_key: 9IHlvJqgkVWMq57a0A56XI5IjhnL5gaRhI1Pszk7S24=

        ips: 192.168.143.254/24,fd8c:bc10:5021::192.168.143.254/48

        allowed_ips: 192.168.143.0/24,fd8c:bc10:5021::/48

        private_key: GLEiXhRwFuhw8aPy+HQfSMwwoLU0Sw8jE8MOxZ8GV3w=

        preshared_key: PWAfvVWCjiNV0Uh2DhmXhdRaT326qosSOcaDB3j9dwI=

Of couse it's highly advised to store all sensitive data in your repository's

secrets.

It could then become something like:

    - name: Set up WireGuard

      uses: egor-tensin/setup-wireguard@v1

      with:

        endpoint: '${{ secrets.ENDPOINT }}'

        endpoint_public_key: '${{ secrets.ENDPOINT_PUBLIC }}'

        ips: '${{ secrets.IPS }}'

        allowed_ips: '${{ secrets.ALLOWED_IPS }}'

        private_key: '${{ secrets.PRIVATE }}'

        preshared_key: '${{ secrets.PRESHARED }}'

API

---

| Input               | Example                                               | Description

| ------------------- | ----------------------------------------------------- | -----------

| endpoint            | 46.46.46.46:51820                                     | Endpoint to connect to in the HOST:PORT format.

| endpoint_public_key | 9IHlvJqgkVWMq57a0A56XI5IjhnL5gaRhI1Pszk7S24=          | Endpoint's public key.

| ips                 | 192.168.143.254/24,fd8c:bc10:5021::192.168.143.254/48 | Comma-separated list of IP addresses to assign to the VM.

| allowed_ips         | 192.168.143.0/24,fd8c:bc10:5021::/48                  | Comma-separated list of netmasks.

| private_key         | GLEiXhRwFuhw8aPy+HQfSMwwoLU0Sw8jE8MOxZ8GV3w=          | Private key of the VM.

| preshared_key       | PWAfvVWCjiNV0Uh2DhmXhdRaT326qosSOcaDB3j9dwI=          | Preshared key assigned to the VM.

License

-------

Distributed under the MIT License.

See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt