From 108a22b8892c3968e84c2015392ecc212f12b4eb Mon Sep 17 00:00:00 2001 From: Tyler Christiansen Date: Fri, 24 Jan 2014 19:44:21 -0800 Subject: [PATCH] add development documentation --- doc/DEVEL.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 doc/DEVEL.md diff --git a/doc/DEVEL.md b/doc/DEVEL.md new file mode 100644 index 000000000..64565f9de --- /dev/null +++ b/doc/DEVEL.md @@ -0,0 +1,22 @@ +# Developing for LibreNMS + +Developing for LibreNMS has never been easier. + +Thanks to [Wes Kennedy](https://twitter.com/liveanarchist), there is +now a vagrant file that will allow you to install a virtual machine +that has LibreNMS already running on it! + +To get started, you can just copy the script from `/contrib/dev_init`, +or you can enter the following commands into your shell: + +``` +mkdir -p dev/librenms && cd $_ +curl -O http://wkennedy.co/uploads/librenms/Vagrantfile +curl -O http://wkennedy.co/uploads/librenms/bootstrap.sh +chmod +x bootstrap.sh +vagrant up +``` + +This may take a few minutes and requires you to already have Vagrant +installed. If you don't have Vagrant installed, it's easy to setup. +See the [installation instructions here](http://docs.vagrantup.com/v2/installation/).