Add missing file

This was missing from d852db439e.
This commit is contained in:
Lucas Bickel 2017-03-10 12:32:45 +01:00
parent d852db439e
commit 8ddc5867ac
1 changed files with 32 additions and 0 deletions

32
docs/vagrant.md Normal file
View File

@ -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.