Getting Started

Web Interface

The SK-VPN Web Interface can be used to manage the SK-VPN system using a web browser.

Use a browser to access the SK-VPN Web Interface:

firefox https://<management_ip_address>/

The SK-VPN Web Interface allows management and monitoring of the SK-VPN:

_images/Dashboard_1.png

HTTPS REST API

The REST API is used to manage the SK-VPN system over HTTPS. The initial HTTPS access is secured using a self-signed certificate. We recommended to use a CA signed certificate see Custom HTTPS Certificates.

The REST API is the recommended access method for the SK-VPN and supports all management operations. The CLI is also used for management but supports only a limited set of management operations.

Use a browser to access the SK-VPN REST API Schema Documentation:

firefox https://<management_ip_address>/api/docs

The SK-VPN REST API Schema Documentation is OpenAPI 3.0 compatible and looks like the following:

_images/rest_api_docs.png

Command Line Interface

The Command Line Interface (CLI) is used to manage the SK-VPN system over SSH or through the serial console.

In Azure access the serial console using the Azure Portal:

  • Access the the Virtual Machines then select your SK-VPN VM.

  • Click on Diagnose and solve Problems then search for the serial console.

  • Launch the Serial Console to access the CLI.

CLI access over SSH is also supported see SSH User Management.

The CLI supports documentation via the ? command.

Python Client (SDK)

The Python client modules are a reference implementation used to manage the SK-VPN using the REST API and the SSH command line.

The client libraries are available from Github and PyPI.

Extensions of the client modules will be available in the future to allow management of a large network of SK-VPNs.

Next Steps: Add users and login to the VM see User Management