https://github.com/josiahsiegel/action-connect-ovpn

Cloned from original OVPN action: golfzaptw/action-connect-ovpn
https://github.com/josiahsiegel/action-connect-ovpn

github-actions ovpn vpn

Last synced: about 2 months ago
JSON representation

Cloned from original OVPN action: golfzaptw/action-connect-ovpn

• Host: GitHub
• URL: https://github.com/josiahsiegel/action-connect-ovpn
• Owner: JosiahSiegel
• Created: 2022-11-16T22:54:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-07T15:55:50.000Z (about 1 year ago)
• Last Synced: 2024-10-18T02:27:52.130Z (2 months ago)
• Topics: github-actions, ovpn, vpn
• Homepage:
• Size: 457 KB
• Stars: 9
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Actions Connect Open VPN


>*Replaced deprecated [`set-output`](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/)*

> v2 switches to openvpn CLI for stability

## Example file `.ovpn` to connect vpn

[Example.ovpn](./example.ovpn)

## Configuration with With

The following settings must be passed as environment variables as shown in the

example.

| Key         | Value                                                                                                                           | Suggested Type | Required | Default         |

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

| `FILE_OVPN` | Location file open vpn and .                                                                                                    | `env`          | **Yes**  | `./config.ovpn` |

| `PING_URL`  | URL for check status vpn connect pass or fail                                                                                   | `env`          | **Yes**  | `127.0.0.1`     |

| `SECRET`    | Username password for access vpn`(Encode base 64 before set secret.)`[How to encode base 64 ?](https://www.base64encode.org/).  | `secret env`   | No       | `''`            |

| `TLS_KEY`   | Tls-crypt for access vpn `(Encode base 64 before set secret.)`[How to encode base 64 ?](https://www.base64encode.org/).         | `secret env`   | No       | `''`            |

## Configuration with Env

The following settings must be passed as environment variables as shown in the

example.

| Key         | Value                                                                                                                           | Suggested Type | Required | Default |

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

| `CA_CRT`    | Certificate for access vpn `(Encode base 64 before set secret.)`[How to encode base 64 ?](https://www.base64encode.org/).       | `secret env`   | **Yes**  | N/A     |

| `USER_CRT`  | User certificate for access vpn. `(Encode base 64 before set secret.)`[How to encode base 64 ?](https://www.base64encode.org/). | `secret env`   | **Yes**  | N/A     |

| `USER_KEY`  | User key for access vpn. `(Encode base 64 before set secret.)`[How to encode base 64 ?](https://www.base64encode.org/).         | `secret env`   | **Yes**  | N/A     |

## Outputs

### `STATUS`

**Boolean** Can get status after connect `true` or `false`.

## Example usage

```yml

  connect-open-vpn:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - name: Install Open VPN

        run: sudo apt-get install openvpn

      - name: Connect VPN

        uses: golfzaptw/action-connect-ovpn@master

        id: connect_vpn

        with:

          PING_URL: '127.0.0.1'

          FILE_OVPN: '.github/vpn/config.ovpn'

          SECRET: ${{ secrets.SECRET_USERNAME_PASSWORD }}

          TLS_KEY: ${{ secrets.TLS_KEY }}

        env:

          CA_CRT: ${{ secrets.CA_CRT}}

          USER_CRT: ${{ secrets.USER_CRT }}

          USER_KEY: ${{ secrets.USER_KEY }}

      - name: Check Connect VPN

        run: echo ${{ steps.connect_vpn.outputs.STATUS }}

      - name: kill vpn

        if: always()

        run: sudo killall openvpn

```

## How to prepare file .ovpn

### Step

1. Copy the data inside the tags

``

``

``

and encode those values to base64. Then save those values (without a new line!) to the secrets in github actions

2. In the .ovpn file in your repo, remove the tags

``

``

` `

and replace the values with

```

ca ca.crt

cert user.crt

key user.key

```

This will allow the values to be filled in from Github secrets.

3. If your open vpn configuration has a username and password please encode those in base64. After that, save the values in the github actions secrets.

format username password

username-vpn

password-vpn

4. If open vpn have tag `` please repeat step 1 and 2 for the TLS records.