Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
libretime/docs/vagrant.md

114 lines
3.9 KiB
Markdown
Raw Normal View History

First round of @paddatrapper changes
2020-05-15 18:51:40 +02:00
Using Vagrant and Virturalbox for developing LibreTime
-------------------------------------------------------
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
The **LibreTime Vagrant install** is the fastet way to get LibreTime up and running in a way
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
to hack on its source code or to test it locally. There are two supported providers: libvirt
and VirtualBox.
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
## Prerequisites
* [Git](https://git-scm.com/)
* [Vagrant](https://vagrantup.com)
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
### Virtual Box
You will need to install [VirtualBox](https://www.virtualbox.org) and may want to consider
installing [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) to update the
guest extensions to match your host system on vagrant up.
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
```bash
vagrant plugin install vagrant-vbguest
```
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
### Libvirt
Setting the libvirt provider up on (Ubuntu and Debian)[#Ubuntu and Debian] is straight
forward, using the distribution provided packages. While on
(Other Distributions)[#Other Distributions] it can be built from within vagrant.
If you try run a libvirt provided box after using a VirtualBox one, you will receive an
error:
```
Error while activating network:
Call to virNetworkCreate failed: internal error: Network is already in use by interface vboxnet0.
```
This is fixed by stopping virtualbox and re-creating the vagrant box:
```
sudo systemctl stop virtualbox
vagrant destroy ubuntu-xenial
vagrant up ubuntu-xenial --provider=libvirt
```
#### Debian and Ubuntu
```bash
include libvirt-dev and recommend reboot
2019-01-18 14:08:12 +01:00
sudo apt install vagrant vagrant-libvirt libvirt-daemon-system vagrant-mutate libvirt-dev
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
sudo usermod -a -G libvirt $USER
include libvirt-dev and recommend reboot
2019-01-18 14:08:12 +01:00
# Reboot
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
Fix vagrant libvirt instructions
2019-01-22 13:13:30 +01:00
vagrant box add bento/ubuntu-16.04 --provider=virtualbox
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
vagrant mutate bento/ubuntu-16.04 libvirt
Fix vagrant libvirt instructions
2019-01-22 13:13:30 +01:00
vagrant up ubuntu-xenial --provider=libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```
#### Other Distributions
You will need to install [libvirt](https://libvirt.org/) and `vagrant-mutate` and then run
```bash
vagrant plugin install vagrant-libvirt
sudo usermod -a -G libvirt $USER
include libvirt-dev and recommend reboot
2019-01-18 14:08:12 +01:00
# Reboot
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
vagrant plugin install vagrant-mutate
vagrant box fetch bento/ubuntu-16.04
vagrant mutate bento/ubuntu-16.04 libvirt
Fix vagrant libvirt instructions
2019-01-22 13:13:30 +01:00
vagrant up ubuntu-xenial --provider=libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
## Starting LibreTime Vagrant
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
To get started you clone the repo and run `vagrant up`. The command accepts a parameter to
change the default provider if you have multiple installed. This can be done by appending
`--provider=virtualbox` or `--provider=libvirt` as applicable.
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
```bash
git clone https://github.com/libretime/libretime.git
cd libretime
:package: (installer) add Ubuntu Bionic Beaver Vagrant box
2018-10-12 19:35:37 +02:00
vagrant up ubuntu-xenial
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
```
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
If everything works out, you will find LibreTime on [port 8080](http://localhost:8080),
icecast on [port 8000](http://localhost:8000) and the docs on
[port 8888](http://localhost:8888).
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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 ubuntu-xenial` in the libretime
directory.
Vagrant Debian support (and experimental CentOS) This changes the Vagrant setup to support multiple installations as multiple boxes. In addition to Ubuntu Vagrant can now be used to install on Debian as well as on CentOS. I took the chance to clean up the .deb install a bit and backported analyzer and celery to SysV proper so it runs there. Some of the distro specfics were moved to the install script from the python setup scripts to acheive this. For the CentOS support I added a rather involved OS prepare script. In the long term this will be added to the preparing-the-server docs we already have. I had to switch the default port to http-alt (8080). On CentOS 9080 is registered for ocsp and getting it to work for apache without hacking SELinux is hard. I think 8080 is the RFC way to go anyhow. If anyone want to override this it should be rather easy using the --web-port arg and by hacking Vagrantfile. The PyOpenSSL code has been refactored for all the distros that the Vagrantfile now supports. As far as my checks go, I tried this code with all the distros, uploaded a track and downloaded a unicode and a ssl podcast and was able to listen to them in each case. In the experimental CentOS case, the UI is not up to spec since services need to get scheduled through systemctl and the status overview (ie. on the /?config page) do not work properly. They need to be as follows: ``` sudo systemctl start airtime-playout sudo systemctl start airtime-liquidsoap sudo systemctl start airtime_analyzer.service sudo systemctl start airtime-celery.service ```
2017-03-08 12:39:59 +01:00
## Alternative OS installations
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
With the above instructions LibreTime is installed on Ubuntu Xenial Xerus. The Vagrant setup
offers the option to choose a different operation system according to you needs.
Vagrant Debian support (and experimental CentOS) This changes the Vagrant setup to support multiple installations as multiple boxes. In addition to Ubuntu Vagrant can now be used to install on Debian as well as on CentOS. I took the chance to clean up the .deb install a bit and backported analyzer and celery to SysV proper so it runs there. Some of the distro specfics were moved to the install script from the python setup scripts to acheive this. For the CentOS support I added a rather involved OS prepare script. In the long term this will be added to the preparing-the-server docs we already have. I had to switch the default port to http-alt (8080). On CentOS 9080 is registered for ocsp and getting it to work for apache without hacking SELinux is hard. I think 8080 is the RFC way to go anyhow. If anyone want to override this it should be rather easy using the --web-port arg and by hacking Vagrantfile. The PyOpenSSL code has been refactored for all the distros that the Vagrantfile now supports. As far as my checks go, I tried this code with all the distros, uploaded a track and downloaded a unicode and a ssl podcast and was able to listen to them in each case. In the experimental CentOS case, the UI is not up to spec since services need to get scheduled through systemctl and the status overview (ie. on the /?config page) do not work properly. They need to be as follows: ``` sudo systemctl start airtime-playout sudo systemctl start airtime-liquidsoap sudo systemctl start airtime_analyzer.service sudo systemctl start airtime-celery.service ```
2017-03-08 12:39:59 +01:00
| OS | Command | Comment |
| ------ | ------------------- | ------- |
add buster to the vagrant machine matrix docs
2019-01-11 11:30:03 +01:00
| Debian 10 | `vagrant up debian-buster` | Install on Debian Buster. |
update stretch version in docs
2019-10-22 11:52:18 +02:00
| Debian 9 | `vagrant up debian-stretch` | Install on current Debian Stretch. Needs manual intervention due to Liquidsoap 1.3.3. |
| Ubuntu 18.04 | `vagrant up ubuntu-bionic` | Install on current Ubuntu Bionic Beaver. |
:package: (installer) add Ubuntu Bionic Beaver Vagrant box
2018-10-12 19:35:37 +02:00
| Ubuntu 16.04 | `vagrant up ubuntu-xenial` | Install on Ubuntu Xenial Xerus. |
:memo: (vagrant) update matrix of supported distros
2018-10-06 12:09:08 +02:00
| CentOS | `vagrant up centos` | Extremely experimental install on 7.3 with native systemd support and activated SELinux. Needs manual intervention due to Liquidsoap 1.3.3. |
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
## Troubleshooting
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
If anything fails during the initial provisioning step you can try running `vagrant provision`
update stretch version in docs
2019-10-22 11:52:18 +02:00
to re-run the installer.
Vagrant Debian support (and experimental CentOS) This changes the Vagrant setup to support multiple installations as multiple boxes. In addition to Ubuntu Vagrant can now be used to install on Debian as well as on CentOS. I took the chance to clean up the .deb install a bit and backported analyzer and celery to SysV proper so it runs there. Some of the distro specfics were moved to the install script from the python setup scripts to acheive this. For the CentOS support I added a rather involved OS prepare script. In the long term this will be added to the preparing-the-server docs we already have. I had to switch the default port to http-alt (8080). On CentOS 9080 is registered for ocsp and getting it to work for apache without hacking SELinux is hard. I think 8080 is the RFC way to go anyhow. If anyone want to override this it should be rather easy using the --web-port arg and by hacking Vagrantfile. The PyOpenSSL code has been refactored for all the distros that the Vagrantfile now supports. As far as my checks go, I tried this code with all the distros, uploaded a track and downloaded a unicode and a ssl podcast and was able to listen to them in each case. In the experimental CentOS case, the UI is not up to spec since services need to get scheduled through systemctl and the status overview (ie. on the /?config page) do not work properly. They need to be as follows: ``` sudo systemctl start airtime-playout sudo systemctl start airtime-liquidsoap sudo systemctl start airtime_analyzer.service sudo systemctl start airtime-celery.service ```
2017-03-08 12:39:59 +01:00
update stretch version in docs
2019-10-22 11:52:18 +02:00
If you only want to re-run parts of the installer, use `--provision-with $step`. The
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
supported steps are `prepare`, `install`, `install-mkdocs` and `start-mkdocs`.