{"id":13410133,"url":"https://github.com/jadolg/vpn2go","last_synced_at":"2026-03-05T02:32:31.053Z","repository":{"id":54226688,"uuid":"260968763","full_name":"jadolg/vpn2go","owner":"jadolg","description":"Easy setup and API management for OpenVPN server","archived":false,"fork":false,"pushed_at":"2023-07-20T15:09:46.000Z","size":34,"stargazers_count":20,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T10:01:34.562Z","etag":null,"topics":["docker-openvpn","hacktoberfest","openvpn","openvpn-server"],"latest_commit_sha":null,"homepage":"","language":"Python","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/jadolg.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":"2020-05-03T16:09:13.000Z","updated_at":"2025-03-02T12:21:57.000Z","dependencies_parsed_at":"2024-10-28T15:00:13.247Z","dependency_job_id":null,"html_url":"https://github.com/jadolg/vpn2go","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jadolg/vpn2go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Fvpn2go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Fvpn2go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Fvpn2go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Fvpn2go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jadolg","download_url":"https://codeload.github.com/jadolg/vpn2go/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Fvpn2go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30107212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T01:39:18.192Z","status":"online","status_checked_at":"2026-03-05T02:00:06.710Z","response_time":93,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["docker-openvpn","hacktoberfest","openvpn","openvpn-server"],"created_at":"2024-07-30T20:01:05.124Z","updated_at":"2026-03-05T02:32:31.035Z","avatar_url":"https://github.com/jadolg.png","language":"Python","funding_links":[],"categories":["API"],"sub_categories":[],"readme":"# Easy to deploy and manage OpenVPN server\n\nOpenVPN server with an API for user management.\nUsing this amazing project https://github.com/kylemanna/docker-openvpn\n\n## Objective\n\nUsing the docker-openvpn is simple and fun, but with time I wanted to automate my user management process and link it to other systems.\nThe goal of this project is creating a basic configuration for docker-openvpn and an web API to manage the users.  \n\n## Requirements\n\n- [Docker](https://www.docker.com/)\n- [Make](https://www.gnu.org/software/make/manual/html_node/Introduction.html)\n- [git](https://git-scm.com/)\n\n## How to deploy\n1. Clone the project and cd into it\n2. Execute `make build` to build the docker images\n3. Edit the .env file and adapt the security related variables to your environment with safe values\n- SERVICE_USER\n- SERVICE_PASSWORD\n4. Export the customization variables to your environment\n- SERVER_ADDRESS\n- CA\n5. Customize your server with these extra variables (optional)\n- PROTOCOL (default:udp)\n- VPN_PORT (default:1194)\n- SERVER_SUBNET (default:192.168.253.0/24)\n- DNS_SERVER (default:1.1.1.1)\n- CLIENT_TO_CLIENT (default:no) Set this to yes if you want the clients to communicate amongst themselves.\n- COMPRESSION (default:yes)\n6. Execute `make configure` to generate the base OpenVPN configuration\n7. Execute `make run` to start the services\n8. Open ports 5000/tcp and 1194/udp in your firewall\n\n## How to use the API\n\n### List all created certificates\n\n`curl -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000`\n\noutput: a list of certificates\n\n### Create a new certificate\n\n`curl -X POST -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000 -d '{\"user\":\"username\"}'`\n\noutput: a text configuration for openvpn\n\n### Create a new certificate with a fixed ip address\n\n`curl -X POST -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000 -d '{\"user\":\"username\", \"ip\":\"192.168.253.5\"}'`\n\noutput: a text configuration for openvpn\n\n*note:* duplicates for ip address are not being handled. Use this at your own risk.\n\n### Create a new certificate with a specific duration in days (default is 1460)\n\n`curl -X POST -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000 -d '{\"user\":\"username\", \"duration\":\"5\"}'`\n\noutput: a text configuration for openvpn\n\n### Get user configuration\n\n`curl -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000/username`\n\noutput: a text configuration for openvpn\n\n### Revoke a certificate\n\n`curl -X DELETE -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000/username`\n\noutput: ok\n\n### Get current status log\n\n`curl -u SERVICE_USER:SERVICE_PASSWORD SERVER_ADDRESS:5000/status`\n\noutput: an openvpn status log\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadolg%2Fvpn2go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjadolg%2Fvpn2go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadolg%2Fvpn2go/lists"}