diff --git a/README.md b/README.md new file mode 100644 index 0000000..4691364 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# AS215085.net Router tools + +```cd /opt && git clone https://git.pixelhosting.nl/Blackwhitebear8/Vyos-BGP-route-visualizer.git``` + +### Requirements +* A working and configured Vyos router + +### Vyos config +1. Login to Vyos and enter configure mode. +2. ```set service https api keys id api key 'YourKey'``` +3. ```set service https listen-address 'VyosIP'``` +4. ```set service https port '80'``` +5. ```set service https allow-client address '0.0.0.0/0'``` + +### App config +1. Edit .env and fill in the details +2. ```apt install -y gunicorn python3 python3-jinja2 python3-flask python3-gunicorn python3-dotenv python3-requests python3-flask python3-matplotlib python3-networkx``` +3. ```gunicorn -w 4 -b 0.0.0.0:5000 app:app``` + +## License + +```This project is licensed under the Apache License 2.0 with the Commons Clause restriction.``` + +```You may use, modify, and distribute this work for personal and non-commercial purposes only.``` + +**You must provide a clear link or reference to the original project when redistributing or using this work.** + +```Commercial use is strictly prohibited.``` \ No newline at end of file