README.md

   1
   2 ## VSCPweb
   3
   4 VSCPweb is a web based software defined networking playground that uses openvswitches (OVS) and a modified version of [mininet](https://github.com/mininet/mininet).
   5 It is a tool that allows you to:
   6 + Create different OVS topologies
   7 + Connect SDN controllers to the virtual network
   8 + Use linux namespace based lightweight containers as hosts or servers in the network
   9 + Monitor the health of all of the worker servers
  10 + Have CLI access to all of the hosts of the virtual network
  11 + Have CLI acc
  12 ess to mininet
  13
  14 ## Table of Contents
  15
  16 * Introduction: #introduction
  17 * Installation: #installation
  18 * Usage: #usage
  19 * Contributing: #contributing
  20 * License: #license
  21
  22 ## Introduction
  23
  24 VSCPweb is a web based network simulator that can be used to learn about and experiment with different network topologies and configurations. It is a valuable tool for anyone who wants to learn more about networking or who needs to test out new network configurations.
  25
  26 VSCPweb is made with golang and htmx. It uses` openvswitches as the underlying network virtualization layer. This allows VSCPweb to create realistic and scalable network simulations.
  27
  28 ## Installation
  29
  30 To install VSCPweb, you will need to have the following dependencies installed:
  31
  32 + golang
  33 + HTMX
  34 + mininet
  35
  36 We are making all of the effort possible into later making distributuion packages that are as distro agnostic as possible but we woul likely not work on window or mac versions (you can still install in a linux VM and access the web console with your browser)
  37
  38 Once you have the dependencies installed, you can install VSCPweb by running the following command:
  39
  40 ```
  41 THIS IS NOT READY YET
  42 ```
  43
  44 ## Usage
  45
  46 To start VSCPweb, run the following command:
  47
  48 ```
  49 vscpweb
  50 ```
  51
  52 VSCPweb will start a web server on port 8080. You can access the VSCPweb interface at http://localhost:8080.
  53
  54 ## Contributing
  55
  56 VSCPweb is an open source project and we welcome contributions from everyone. If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.
  57
  58 ## Demo
  59
  60 We plan to have a small limited demo running in https://vscp.josue.xyz but it is not yet public due to the extent of control that vscp can excert over the host system.
  61
  62 ## License
  63
  64 VSCPweb is licensed under the GPLv3 License.
  65 + The GPLv3 license is published by the Free Software Foundation (FSF).
  66 + The GPLv3 license is version 3 of the GNU General Public License (GPL).
  67 + The GPLv3 license is a copyleft license.
  68 + The GPLv3 license prohibits patent claims on the software.
  69 + The GPLv3 license has stronger copyleft provisions than the GPLv2 license.
  70 + The GPLv3 license prohibits the use of DRM technologies in the software.
  71 See the LICENSE file for more information.
  72
  73 ## Contact
  74
  75
  76 ## Contact
  77
  78 If you have any questions or concerns, please feel free to contact us by email at [email protected] or by opening an issue on GitHub.
  79
  80 We are always happy to help and we will get back to you as soon as possible.
  81
  82 Thank you for using VSCPweb!