README.md

   1 ## VSCPweb
   2
   3 VSCPweb is a web based software defined networking playground that uses openvswitches (OVS) and a modified version of [mininet](https://github.com/mininet/mininet).
   4 It is a tool that allows you to:
   5 + Create different OVS topologies
   6 + Connect SDN controllers to the virtual network
   7 + Use linux namespace based lightweight containers as hosts or servers in the network
   8 + Monitor the health of all of the worker servers
   9 + Have CLI access to all of the hosts of the virtual network
  10 + Have CLI access to mininet
  11
  12 ## Table of Contents
  13
  14 * Introduction: #introduction
  15 * Installation: #installation
  16 * Usage: #usage
  17 * Contributing: #contributing
  18 * License: #license
  19
  20 ## Introduction
  21
  22 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.
  23
  24 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.
  25
  26 ## Installation
  27
  28 To install VSCPweb, you will need to have the following dependencies installed:
  29
  30 + golang
  31 + HTMX
  32 + mininet
  33
  34 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)
  35
  36 Once you have the dependencies installed, you can install VSCPweb by running the following command:
  37
  38 ```
  39 THIS IS NOT READY YET
  40 ```
  41
  42 ## Usage
  43
  44 To start VSCPweb, run the following command:
  45
  46 ```
  47 vscpweb
  48 ```
  49
  50 VSCPweb will start a web server on port 8080. You can access the VSCPweb interface at http://localhost:8080.
  51
  52 ## Contributing
  53
  54 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.
  55
  56 ## Demo
  57
  58 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.
  59
  60 ## License
  61
  62 VSCPweb is licensed under the GPLv3 License.
  63 + The GPLv3 license is published by the Free Software Foundation (FSF).
  64 + The GPLv3 license is version 3 of the GNU General Public License (GPL).
  65 + The GPLv3 license is a copyleft license.
  66 + The GPLv3 license prohibits patent claims on the software.
  67 + The GPLv3 license has stronger copyleft provisions than the GPLv2 license.
  68 + The GPLv3 license prohibits the use of DRM technologies in the software.
  69 See the LICENSE file for more information.
  70
  71 ## Contact
  72
  73 If you have any questions or concerns, please contact leave an issue on GitHub.