From 8ddc5867ac4b061c74b5e3f0db83093ba8166b97 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Fri, 10 Mar 2017 12:32:45 +0100 Subject: [PATCH] Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb. --- docs/vagrant.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/vagrant.md diff --git a/docs/vagrant.md b/docs/vagrant.md new file mode 100644 index 000000000..b004d49d8 --- /dev/null +++ b/docs/vagrant.md @@ -0,0 +1,32 @@ +The **LibreTime Vagrant install** is the fastet way to get LibreTime up and running in a way +to hack on its source code or to test it locally. + +## Prerequisites + +* [Git](https://git-scm.com/) +* [VirtualBox](https://www.virtualbox.org) +* [Vagrant](https://vagrantup.com) + +You might also want to install [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) to update the guest extensions to match your host system on vagrant up. + +```bash +vagrant plugin install vagrant-vbguest +``` + +## Starting LibreTime Vagrant + +To get started you clone the repo and run `vagrant up`. + +```bash +git clone https://github.com/libretime/libretime.git +cd libretime +vagrant up +``` + +If everything works out, you will find LibreTime on [port 9080](http://localhost:9080), icecast on [port 8000](http://localhost:8000) and the docs on [port 8888](http://localhost:8888). + +Once you reach the web setup GUI you can click through it using the default values. To connect to the vagrant machine you can run `vagrant ssh` in the libretime directory. + +## Troubleshooting + +If anything fails during the initial provisioning step you can try running `vagrant provision` to rerun the installer.