[{"_1":2,"_171":-5,"_172":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_147":148},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_140":-5,"_141":11,"_142":17,"_143":11,"_144":-5,"_145":146},"canonicalUrl","https://hub.docker.com/r/sjdaws/cloudserver-vpn/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","sjdaws","reponame","cloudserver-vpn","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2024-04-04T01:07:28.681464Z","description","Run a New Zealand based VPN on demand for only 1.5c per hour","is_private","last_updated","2024-07-08T21:47:50.026412Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.oci.image.index.v1+json","name","pull_count",3059,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# CloudServer VPN\n\nRun a New Zealand based VPN on demand for only [1.5c per hour](https://voyager.nz/business/hosting/virtual-servers#balanced).\n\n## Prerequisites\n\nSome initial set up is required.\n\n### Cloud Server\n\nThis system utilises [Voyager VPS Manager](https://voyager.nz/business/hosting/virtual-servers) to create servers to run WireGuard. You must sign up to use VPS Manager and [generate an API token](https://cloudserver.nz/account#api-tokens).\n\n### Wireguard\n\nYou will need to have a [private/public key pair](https://www.wireguard.com/quickstart/#key-generation) for both the server and at least one peer.\n\nYou will also need to decide what [private network range](https://datatracker.ietf.org/doc/html/rfc1918#section-3) WireGuard should use. This must be unique to WireGuard and not conflict with your home private network range. _Most_ home networks use IPs in `192.168.0.0/23` or `10.0.0.0/23` ranges by default, so these should probably be avoided. Picking something completely random is good, e.g. `10.194.89.0/24`. The range only needs to be big enough to support your server and any peers. Two peers (and the server) use three IPs total, so `/30` would be sufficient.\n\n## Usage\n\nThe app accepts three command line arguments, which have different configuration requirements. Configuration is read through environment variables.\n\n### Create VPN\n\nA VPN can be created by using `cloudserver-vpn --create`\n\n| Key | Description | Mandatory |\n|-----|-------------|-----------|\n| CLOUDFLARE_APIKEY | [Scoped API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) to update a Cloudflare DNS record | N |\n| CLOUDFLARE_ZONE | The name of the Cloudflare zone to update, e.g. example.com | N |\n| CLOUDSERVER_APIKEY | [API token](https://cloudserver.nz/account#api-tokens) for cloudserver.nz | Y |\n| CLOUDSERVER_PROJECT | The ID of the [Cloud Server project](https://cloudserver.nz/projects) where the server will be provisioned¹ | N |\n| SERVER_NAME | The name for this server, must be [a valid RFC 3696 subdomain](https://datatracker.ietf.org/doc/html/rfc3696) | Y |\n| WIREGUARD_ADDRESS | The IPv4 CIDR to use for the WireGuard interface, must include a big enough subnet to accomodate all peers, e.g. `10.194.89.1/24` | Y |\n| WIREGUARD_LISTENPORT | The port for WireGuard to listen on, if not specified, `51820` will be used | N |\n| WIREGUARD_PEER#\\_ALLOWEDIPS | The IPv4 CIDR to allow connections for peer #², e.g. `10.194.89.2/32` | Y |\n| WIREGUARD_PEER#\\_PUBLICKEY | The public key for the associated peer | Y |\n| WIREGUARD_PRIVATEKEY | The private key for the WireGuard server | Y |\n\n¹ If a project is not specified a new project called `VPNs` will be created. This project **must** only contain VPN servers as all servers will be removed when `--remove` is called.\n
\n² You can add up to 255 peers as long as the pair of `ALLOWEDIPS` and `PUBLICKEY` are both specified. Peer prefixes range from `WIREGUARD_PEER0_...` to `WIREGUARD_PEER254_...`.\n\n### Remove all VPNs\n\nAll VPNs can be removed by using `cloudserver-vpn --remove`\n\nThis command will remove **all** servers in the Cloud Server project.\n\n| Key | Description | Mandatory |\n|-----|-------------|-----------|\n| CLOUDSERVER_APIKEY | [API token](https://cloudserver.nz/account#api-tokens) for cloudserver.nz | Y |\n| CLOUDSERVER_PROJECT | The ID of the [Cloud Server project](https://cloudserver.nz/projects) where the server is provisioned | N |\n\n### Remove a single VPN\n\nA single VPN can be removed by using `cloudserver-vpn --remove `\n\n| Key | Description | Mandatory |\n|-----|-------------|-----------|\n| CLOUDSERVER_APIKEY | [API token](https://cloudserver.nz/account#api-tokens) for cloudserver.nz | Y |\n\n### Run as HTTP server\n\nAn HTTP server can be run by using `cloudserver-vpn --serve`\n\nThe HTTP server requires the same configuration as [Create VPN](#create-vpn) with an additional configuration for http port.\n\n| Key | Description | Mandatory |\n|-----|-------------|-----------|\n| HTTP_PORT | Port to listen for HTTP connections on, if not specified `5252` will be used | N |\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",52316579,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":128,"_129":90,"_130":29,"_131":52,"_53":132,"_133":134,"_135":136,"_137":128,"_138":62,"_139":17},"content_type","creator",5680644,"digest","sha256:b83cfce6f210f356bfe4cc4d29f61aa562b4d3fd16046afba6734e2a1eed3a34","full_size",9180814,"id",632931057,"images",[99,115,120,125],{"_100":101,"_91":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":94,"_59":62,"_114":-5},"architecture","amd64","sha256:08583ddf016f82557f9ad22c35e3492a7fb64d14d68ddb5654d55ad6492eb7c8","features","","last_pulled","2026-09-07T10:16:11.506137476Z","last_pushed","2024-07-08T21:47:49Z","os","linux","os_features","os_version","size","variant",{"_100":116,"_91":117,"_103":104,"_105":118,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":119,"_59":62,"_114":-5},"arm64","sha256:0735c6135bdf36788c9f1f2ef50cc289d27c1bff0d84a2f6516e13656c50f7bc","2026-09-18T05:02:37.77026184Z",9319372,{"_100":121,"_91":122,"_103":104,"_105":123,"_107":108,"_109":121,"_111":104,"_112":-5,"_113":124,"_59":62,"_114":-5},"unknown","sha256:44ed8b2cab31df723da38a66b99b6f01d9500ed8a5f50bed95322bb6cba9e4e7","2026-09-07T10:16:11.497008755Z",1338,{"_100":121,"_91":126,"_103":104,"_105":127,"_107":108,"_109":121,"_111":104,"_112":-5,"_113":124,"_59":62,"_114":-5},"sha256:f0434d9c80e9c7be23bb5af7f056ced27567655509a5642d08cc65367ba80ef4","2026-09-07T10:16:11.506163374Z","2024-07-08T21:47:49.488484Z","last_updater","last_updater_username","media_type","latest","repository",23738616,"tag_last_pulled","2026-09-19T12:35:44.140398441Z","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":149,"_156":157,"_145":169,"_170":11},{"_36":150,"_38":151,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":152,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":153,"_75":11,"_76":155,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":154},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_158":60,"_159":-5,"_160":-5,"_161":162},"count","next","previous","results",[163],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":164,"_46":128,"_129":90,"_130":29,"_131":52,"_53":132,"_133":134,"_135":136,"_137":128,"_138":62,"_139":17},[165,166,167,168],{"_100":101,"_91":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":94,"_59":62,"_114":-5},{"_100":116,"_91":117,"_103":104,"_105":118,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":119,"_59":62,"_114":-5},{"_100":121,"_91":122,"_103":104,"_105":123,"_107":108,"_109":121,"_111":104,"_112":-5,"_113":124,"_59":62,"_114":-5},{"_100":121,"_91":126,"_103":104,"_105":127,"_107":108,"_109":121,"_111":104,"_112":-5,"_113":124,"_59":62,"_114":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
08583ddf016f	linux/amd64	8.76 MB
0735c6135bdf	linux/arm64	8.89 MB

sjdaws/cloudserver-vpn

Tags for sjdaws/cloudserver-vpn