{"id":42398233,"url":"https://github.com/eshork/universal-openvpn","last_synced_at":"2026-01-28T01:11:16.900Z","repository":{"id":239651391,"uuid":"799048006","full_name":"eshork/universal-openvpn","owner":"eshork","description":"Establishes an OpenVPN client connection on startup of LinuxServer.io containers","archived":false,"fork":false,"pushed_at":"2024-05-14T15:02:16.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-15T04:24:28.936Z","etag":null,"topics":["deluge","docker","docker-mod","linuxserver-mod","openvpn","openvpn-client"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eshork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-05-11T03:35:23.000Z","updated_at":"2024-05-14T03:25:04.000Z","dependencies_parsed_at":"2024-05-13T21:26:36.452Z","dependency_job_id":"a1eb42e9-9ae4-48cf-bd18-a04f77c826dd","html_url":"https://github.com/eshork/universal-openvpn","commit_stats":null,"previous_names":["eshork/universal-openvpn"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eshork/universal-openvpn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshork%2Funiversal-openvpn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshork%2Funiversal-openvpn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshork%2Funiversal-openvpn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshork%2Funiversal-openvpn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eshork","download_url":"https://codeload.github.com/eshork/universal-openvpn/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshork%2Funiversal-openvpn/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28831237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T23:29:49.665Z","status":"ssl_error","status_checked_at":"2026-01-27T23:25:58.379Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["deluge","docker","docker-mod","linuxserver-mod","openvpn","openvpn-client"],"created_at":"2026-01-28T01:11:16.192Z","updated_at":"2026-01-28T01:11:16.888Z","avatar_url":"https://github.com/eshork.png","language":"Shell","readme":"# OpenVPN Docker Mod\n\nAn s6 v3 [docker-mod][linuxserver/docker-mods] for [LinuxServer.io] containers that establishes an OpenVPN connection on container startup.\n\n## Usage\n\nTo use this mod, add the following environment variables to your [LinuxServer.io] container:\n\nIn docker arguments, set an environment variable `DOCKER_MODS=ghcr.io/eshork/universal-openvpn:latest` to enable.\n\nIf adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=user/repo:tag|user/repo:tag`\n\n\n## Settings\n### Environment variables\n- `OVPN_CONFIG`: Full path to the OpenVPN configuration file to use. Default is `/etc/openvpn/config`. (Provide this file to your container as a volume mount.)\n- `OVPN_CREDENTIALS`: Full path to the credentials file to pass via `--auth-user-pass`. Default is `/etc/openvpn/credentials`. If not present, will not pass credentials. (Provide this file to your container as a volume mount.)\n- `OVPN_KILLSWITCH`: If set to `true` or `1`, will implement a route-based traffic kill switch, attempting to prevent traffic leaking beyond your local network when the VPN tunnel is down.\n- `OVPN_SPLIT_PRIVATE`: If set to `true` or `1`, will inject routes to preserve access to private network addresses (RFC1918) via the initial default route. Default is `false`.\n- `OVPN_HALT_ON_FAILURE`: If set to `true` or `1`, will issue `halt` command to stop the container if the OpenVPN connection is lost or could not be established. Default will not attempt to stop the container.\n- `OVPN_OPTS_ADD`: Additional options to append to the `openvpn` command. Default is empty.\n- `OVPN_OPTS_OVERRIDE`: If set, will completely override the generated `openvpn` command arguments with the provided value. This is useful for advanced users who want full control over the `openvpn` command arguments, but is often not necessary. Default is empty.\n\n## Misc\n\nONLY TESTED ON AN ALPINE BASED CONTAINER\n\nBased on documentation from\n- [linuxserver/docker-mods]\n- [man 8 openvpn]\n- [protonvpn linux-openvpn]\n- [s6]\n- [just-containers/s6-overlay]\n\n[LinuxServer.io]: https://www.linuxserver.io/\n[protonvpn linux-openvpn]: https://protonvpn.com/support/linux-openvpn\n[linuxserver/docker-mods]: https://github.com/linuxserver/docker-mods\n[just-containers/s6-overlay]: https://github.com/just-containers/s6-overlay\n[man 8 openvpn]: https://manpages.org/openvpn/8\n[s6]: https://skarnet.org/software/s6/index.html\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feshork%2Funiversal-openvpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feshork%2Funiversal-openvpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feshork%2Funiversal-openvpn/lists"}