{"id":15891412,"url":"https://github.com/dbritto-dev/openvpn3-action","last_synced_at":"2025-10-04T07:20:11.717Z","repository":{"id":69761753,"uuid":"477063000","full_name":"dbritto-dev/openvpn3-action","owner":"dbritto-dev","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-20T00:47:49.000Z","size":32,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-09T09:04:07.527Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/dbritto-dev.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":"2022-04-02T13:29:37.000Z","updated_at":"2025-01-20T10:22:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"ef57cb84-776b-4346-a42c-7f4c53f4c7b4","html_url":"https://github.com/dbritto-dev/openvpn3-action","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbritto-dev%2Fopenvpn3-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbritto-dev%2Fopenvpn3-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbritto-dev%2Fopenvpn3-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbritto-dev%2Fopenvpn3-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbritto-dev","download_url":"https://codeload.github.com/dbritto-dev/openvpn3-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246857885,"owners_count":20845205,"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":[],"created_at":"2024-10-06T07:22:00.986Z","updated_at":"2025-10-04T07:20:06.668Z","avatar_url":"https://github.com/dbritto-dev.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenVPN 3 Action\n\nThis action starts a VPN session using OpenVPN 3 and give you the option to run\nany bash script during the session. We recommend you to store your config files\nin GitHub using [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).\n\n\u003e **Note:** this action only support linux (`ubuntu`).\n\u003e Please use one of the [virtual environments](https://github.com/actions/virtual-environments#available-environments)\n\u003e for linux (`ubuntu`) supported by GitHub Actions.\n\n**Reference Links:**\n\n- [OpenVPN 3 for Linux](https://openvpn.net/cloud-docs/openvpn-3-client-for-linux/)\n- [OpenVPN 3 and auth-user-pass](https://openvpn.net/blog/openvpn-3-linux-and-auth-user-pass/)\n- [GitHub Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)\n\n# Usage\n\n```yaml\n- uses: dbritto-dev/openvpn3-action@main\n  with:\n    # Description: OpenVPN 3 profile file (.ovpn/.conf).\n    # Encoded: Base64\n    # Required: true\n    vpn-client-config: \"\"\n    # Description: OpenVPN 3 Autoload config file (.autoload). If this input is provided we use\n    # `openvpn3-autoload` instead of `openvpn3` to start the VPN session.\n    # OpenVPN 3 does support `auth-user-pass` through `openvpn3-autoload` utility.\n    # To read more about OpenVPN 3 and `auth-user-pass` go to https://openvpn.net/blog/openvpn-3-linux-and-auth-user-pass/\n    # Encoded: Base64\n    # Required: false\n    # Default: ''\n    vpn-autoload-config: \"\"\n    # Description: Bash script to run after the session was started and before the session was closed.\n    # Required: true\n    script: |\n      echo \"Hello Developer!\"\n```\n\n# Scenarios\n\n- [Basic usage using OpenVPN 3 profile](#basic-usage-using-openvpn-3-profile)\n- [Using OpenVPN 3 profile wih auth-user-pass](#using-openvpn-3-profile-wih-auth-user-pass)\n\n## Using OpenVPN 3 profile\n\n```yaml\non: [push]\n\njobs:\n  testing:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: dbritto-dev/openvpn3-action@main\n        with:\n          vpn-client-config: ${{ secrets.VPN_CLIENT_CONFIG }}\n          script: |\n            sudo openvpn3 sessions-list\n```\n\n## Using OpenVPN 3 profile wih auth-user-pass\n\n```yaml\non: [push]\n\njobs:\n  testing:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: dbritto-dev/openvpn3-action@main\n        with:\n          vpn-client-config: ${{ secrets.VPN_CLIENT_CONFIG }}\n          vpn-autoload-config: ${{ secrets.VPN_AUTOLOAD_CONFIG }}\n          script: |\n            sudo openvpn3 sessions-list\n```\n\n\u003e Note: this approach should be deprecated soon. Please use do not use `vpn-autoload-config` anymore.\n\n# License\n\nThe scripts and documentation in this project are released under the [MIT License](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbritto-dev%2Fopenvpn3-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbritto-dev%2Fopenvpn3-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbritto-dev%2Fopenvpn3-action/lists"}