{"id":15639834,"url":"https://github.com/kota65535/github-openvpn-connect-action","last_synced_at":"2025-04-12T18:43:29.466Z","repository":{"id":42370398,"uuid":"306921237","full_name":"kota65535/github-openvpn-connect-action","owner":"kota65535","description":"GitHub Action for connecting to OpenVPN server.","archived":false,"fork":false,"pushed_at":"2024-10-18T22:18:29.000Z","size":523,"stargazers_count":86,"open_issues_count":12,"forks_count":55,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-30T05:54:40.389Z","etag":null,"topics":["github-actions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kota65535.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-24T16:10:01.000Z","updated_at":"2024-10-16T23:12:44.000Z","dependencies_parsed_at":"2024-04-03T17:27:01.242Z","dependency_job_id":"7f08902f-99a9-49d4-821c-151ab3c0e5dc","html_url":"https://github.com/kota65535/github-openvpn-connect-action","commit_stats":{"total_commits":78,"total_committers":5,"mean_commits":15.6,"dds":"0.21794871794871795","last_synced_commit":"cd2ed8a90cc7b060dc4e001143e811b5f7ea0af5"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kota65535%2Fgithub-openvpn-connect-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kota65535%2Fgithub-openvpn-connect-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kota65535%2Fgithub-openvpn-connect-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kota65535%2Fgithub-openvpn-connect-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kota65535","download_url":"https://codeload.github.com/kota65535/github-openvpn-connect-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248617130,"owners_count":21134190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions"],"created_at":"2024-10-03T11:27:37.791Z","updated_at":"2025-04-12T18:43:29.430Z","avatar_url":"https://github.com/kota65535.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-openvpn-connect-action\n\nGitHub Action for connecting to OpenVPN server.\n\n## Inputs\n\n### General Inputs\n\n| Name          | Description                            | Required |\n|---------------|----------------------------------------|----------|\n| `config_file` | Location of OpenVPN client config file | yes      |\n| `echo_config` | Echo OpenVPN config file to the log    | no       |\n\n### Authentication Inputs\n\nSupported authentication methods:\n\n- Username \u0026 password auth\n- Client certificate auth\n- Both of them\n\n| Name               | Description                        | Required when           | \n|--------------------|------------------------------------|-------------------------|\n| `username`         | Username                           | Username-password auth  |\n| `password`         | Password                           | Username-password auth  |\n| `client_key`       | Local peer's private key           | Client certificate auth |\n| `tls_auth_key`     | Pre-shared group key for TLS Auth  | Optional                |\n| `tls_crypt_key`    | Pre-shared group key for TLS Crypt | Optional                |\n| `tls_crypt_v2_key` | Per-client key for TLS Crypt V2    | Optional                |\n\n\u003e **Note: It is strongly recommended that you provide all credentials\nvia [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).**\n\nWhen providing TLS keys, you should provide *only one of* either `tls_auth_key`, `tls_crypt_key` or `tls_crypt_v2_key`.\nYou can determine which by checking the value of your key and looking in the header line. \n[See the docs for more info about TLS in OpenVPN](https://openvpn.net/vpn-server-resources/tls-control-channel-security-in-openvpn-access-server)\n\n## Usage\n\n- Create client configuration file based on\n  the [official sample](https://github.com/OpenVPN/openvpn/blob/master/sample/sample-config-files/client.conf). It is\n  recommended to use inline certificates to include them directly in configuration file\n  like [this](https://github.com/kota65535/github-openvpn-connect-action/tree/master/.github/workflows/client.ovpn).\n- Usage in your workflow is like following:\n\n```yaml\n      - name: Checkout\n        uses: actions/checkout@v3\n      - name: Install OpenVPN\n        run: |\n          sudo apt update\n          sudo apt install -y openvpn openvpn-systemd-resolved\n      - name: Connect to VPN\n        uses: \"kota65535/github-openvpn-connect-action@v2\"\n        with:\n          config_file: .github/workflows/client.ovpn\n          username: ${{ secrets.OVPN_USERNAME }}\n          password: ${{ secrets.OVPN_PASSWORD }}\n          client_key: ${{ secrets.OVPN_CLIENT_KEY }}\n          tls_auth_key: ${{ secrets.OVPN_TLS_AUTH_KEY }}\n      - name: Build something\n        run: ./gradlew clean build\n      # The openvpn process is automatically terminated in post-action phase\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkota65535%2Fgithub-openvpn-connect-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkota65535%2Fgithub-openvpn-connect-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkota65535%2Fgithub-openvpn-connect-action/lists"}