Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.
/ vpn-client Public archive

Waits for a valid openvpn configuration file and starts the vpn client

License

Notifications You must be signed in to change notification settings

nuvlaedge/vpn-client

Repository files navigation

ℹ️ This component has moved ➡️

It is now part of 👉 nuvlaedge/nuvlaedge 👈.


NuvlaEdge VPN Client

Maintenance GitHub issues Docker pulls Docker image size

CI Build CI Release

This repository contains the source code for the NuvlaEdge VPN client - the microservice that starts the vpn client in the NuvlaEdge.

This microservice is an integral component of the NuvlaEdge Engine.


NOTE: this microservice is part of a loosely coupled architecture, thus when deployed by itself, it might not provide all of its functionalities. Please refer to https://github.com/nuvlaedge/deployment for a fully functional deployment


Build the NuvlaEdge VPN Client

This repository is already linked with Travis CI, so with every commit, a new Docker image is released.

There is a POM file which is responsible for handling the multi-architecture and stage-specific builds.

If you're developing and testing locally in your own machine, simply run docker build . or even deploy the microservice via the local compose files to have your changes built into a new Docker image, and saved into your local filesystem.

If you're developing in a non-master branch, please push your changes to the respective branch, and wait for Travis CI to finish the automated build. You'll find your Docker image in the nuvladev organization in Docker hub, names as nuvladev/vpn-client:<branch>.

Deploy the NuvlaEdge VPN Client

Prerequisites

  • Docker (version 18 or higher)
  • Docker Compose (version 1.23.2 or higher)

Launching the NuvlaEdge VPN Client

Simply run docker-compose up --build

Contributing

This is an open-source project, so all community contributions are more than welcome. Please read CONTRIBUTING.md

Copyright

Copyright © 2021, SixSq SA