vycontrol

VyControl

VyControl is a single frontend interface to manage a single or multiple VyoS servers. Only download VyOS Rolling Release, since VyControl needs the latest VyOS API.

Still in 2020, the most important functionalities that until then were only possible through CLI (command line interface), will be possible through a friendly and web interface developed in Django / Python.

Standalone VyoS installations can now have a control panel.

Datacenter installations with multiple VyoS will be able to offer their customers (with users, groups and granular control) firewall as a service.

Main links

• VyControl website
• VyOS linux firewall website (only compatible with rolling release / 1.3 VyOS)

Plan to use VyControl?

• Subscribe to our announce list at https://vycontrol.com/
• Join Slack Channel https://vycontrol.slack.com/archives/C012ZRMB8VB
• Add new enhancement requests at https://github.com/vycontrol/vycontrol/issues

Plan to develop VyControl?

• Solve Issues at https://github.com/vycontrol/vycontrol/issues
• Forks and pull requests are welcome!
• Discussion VyControl at VyOS forum https://forum.vyos.io/t/vycenter-alpha-stage-announcement-vyos-web-interface/5221/4

roadmap

current version

• 20.05.01 - version created to start project framework, organize permission systems and concept test with some firewall and interface functions and statics routes

future versions

• 20.05.02.1000 - working firewall without zones
• 20.05.04.1000 - improve error returns to end users
• 20.05.07.1000 - vlans / interfaces deep configuration
• 20.05.10.1000 - working firewall with zones
• 20.06.01.1000 - commit, save, load and system login
• 20.06.03.1000 - granular permissions and improvements
• 20.06.09.1000 - save/commit/load features and ssh / logins
• 20.06.10.1000 - lost password
• 20.06.13.1000 - ipsec features
• 20.06.15.1000 - layout
• 25.06.20-LTS - OSPF features
• 25.07.01.1000 – FastNetMon one-click integration
• 25.07.05.1000 – Finish firewall options
• 25.08.01.1000 - s3 backup scheduler and commit confirm
• 25.08.05.1000 - improve permissions cleanups
• 25.12.10.1000 - ipv6 milestone
• 25.12.20.1000 - depend on a third party

versions convention

Note that versions numbers are not related to dates.

• major eg 20
  • minor eg 05
  • feature eg 05
    • build eg 1010

Will give 20.05.05.1010

lifecycle

• initially LTS (Long Term Support) versions will be supported by 6 months just to bugfixes
• in the future we will extend the time span of LTS versions

installation

• for your security edit SECRET_KEY in inside Django settings.py and change to something random, maybe using

  openssl rand -hex 32
  

by dockerhub

latest VyControl is being autobuilt at dockerhub https://hub.docker.com/r/robertoberto/vycontrol

docker pull robertoberto/vycontrol

by docker composer

Right now we are using db.sqlite3, but I used composer so we can change to mySQL if needed.

docker-compose build
docker-compose  up

manual install instructions

setup virtual env and pip requirements

virtualenv env
source env/bin/activate
pip3 install -r requirements.txt

setup initial database

cd vycenter
python3 manage.py migrate

run webserver

python3 manage.py runserver

access webpage

http://127.0.0.1:8000/

setup vyos new instance

• click on Add new instance
• configure vyos services like explained here https://docs.vyos.io/en/latest/appendix/http-api.html
• click on List Instances
• click on Test Connection

references

• https://docs.vyos.io/en/latest/appendix/http-api.html
• https://forum.vyos.io/t/http-api-for-show/3922
• https://blog.vyos.io/vyos-rolling-release-has-got-an-http-api
• https://www.facebook.com/VyControl-101048288289351

screenshoots (keep in mind we're in early alpha stages)

Install VyControl

List Users

List VyOS Instances

Add VyOS Instances

List Interfaces

List Firewall

Add Firewall Rule

List Static Routes

Sponsoring

• VyControl is being tested at Under a Brazilian provider of Cloud Computing and Datacenters.