Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 3.82 KB

README.md

File metadata and controls

90 lines (70 loc) · 3.82 KB

Actions Connect Open VPN

This action is a connect ovpn script

Example file .ovpn to connect vpn

Test.ovpn and setup file

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 ?. secret env No ''
TLS_KEY Tls-crypt for access vpn (Encode base 64 before set secret.)How to encode base 64 ?. 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 ?. secret env Yes N/A
USER_CRT User certificate for access vpn. (Encode base 64 before set secret.)How to encode base 64 ?. secret env Yes N/A
USER_KEY User key for access vpn. (Encode base 64 before set secret.)How to encode base 64 ?. secret env Yes N/A

Outputs

STATUS

Boolean Can get status after connect true or false.

Example usage

  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 data inside tag <ca></ca> <cert></cert> <key></key> to encode base64 after that save to secret env github actions

  2. Remove tag <ca></ca> <cert></cert> <key></key> and replace to ca ca.crt cert user.crt key user.key

  3. If open vpn have username and password please encode base64 after that save to secret env github actions format username password username-vpn password-vpn

  4. If open vpn have tag <tls></tls> please make step 1 and 2