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

109 lines
3.6 KiB
Markdown
Raw Normal View History

Some nav fixed. More to go.
2020-05-18 04:08:09 +02:00
---
Starting work on new design for docs pages
2020-11-01 04:23:29 +01:00
layout: article
Updating links, adding FAQ page, massaging file structure
2020-11-03 05:14:27 +01:00
title: Using Vagrant for local development
category: dev
Some nav fixed. More to go.
2020-05-18 04:08:09 +02:00
---
Fixing toc for github pages
2020-06-07 19:23:26 +02:00
> Prerequisites: git, [Vagrant](https://vagrantup.com), libvirt or VirtualBox
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
Working on docs
2020-06-11 03:42:31 +02:00
## VirtualBox
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
```
Working on docs
2020-06-11 03:42:31 +02:00
## Libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
Removed bad links
2020-07-02 18:23:30 +02:00
Setting the libvirt provider up on Ubuntu and Debian is straight-forward,
using the distribution provided packages. While on
other distributions it can be built from within vagrant.
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
vagrant destroy ubuntu-bionic
vagrant up ubuntu-bionic --provider=libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```
Working on docs
2020-06-11 03:42:31 +02:00
### Debian and Ubuntu
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```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 vagrant.md
2021-04-08 19:33:32 +02:00
sudo usermod -aG libvirt $USER
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
vagrant box add bento/ubuntu-18.04 --provider=virtualbox
vagrant mutate bento/ubuntu-18.04 libvirt
vagrant up ubuntu-bionic --provider=libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```
Working on docs
2020-06-11 03:42:31 +02:00
### Other Distributions
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
vagrant box fetch bento/ubuntu-18.04
vagrant mutate bento/ubuntu-18.04 libvirt
vagrant up ubuntu-bionic --provider=libvirt
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
```
Working on docs
2020-06-11 03:42:31 +02:00
## Starting LibreTime Vagrant
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
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
vagrant up ubuntu-bionic
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
```
Working on Backing up the Server docs/scripts
2020-11-15 03:36:14 +01:00
If everything works out, you will find LibreTime on [port 8080](http://localhost:8080)
and Icecast on [port 8000](http://localhost:8000).
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
connect to the vagrant machine you can run `vagrant ssh ubuntu-bionic` in the libretime
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
Working on docs
2020-06-11 03:42:31 +02:00
## Alternative OS installations
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
Drop Ubuntu Xenial support Fixes: #1226
2021-06-18 22:37:43 +02:00
With the above instructions LibreTime is installed on Ubuntu Bionic. The Vagrant setup
Update docs to include how to use libvirt vagrant
2019-01-18 11:08:28 +01:00
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
feat: debian 11 support (#1292) * Debian 11 Support Run api ci test on bullseye as well * Silan does not work for mp3 on bullseye * Liquisoap does not fail with wma files on bullseye
2021-11-09 10:21:40 +01:00
| OS | Command | Comment |
| ------------ | ---------------------------- | ----------------------------------------------------------- |
| Debian 10 | `vagrant up debian-buster` | Install on Debian Buster. |
| Debian 11 | `vagrant up debian-bullseye` | Install on Debian Bullseye. |
| Ubuntu 18.04 | `vagrant up ubuntu-bionic` | Install on Ubuntu Bionic Beaver. |
| Ubuntu 20.04 | `vagrant up ubuntu-focal` | Install on Ubuntu Focal Fossa. |
| CentOS | `vagrant up centos` | CentOS 8 with native systemd support and activated SELinux. |
Add missing file This was missing from d852db439ef979767d2c2c9d58fcf177622796eb.
2017-03-10 12:32:45 +01:00
Working on docs
2020-06-11 03:42:31 +02:00
## Troubleshooting
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 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
Typo on vagrant.md
2020-06-02 20:01:31 +02:00
supported steps are `prepare` and `install`.