Adding instructions for Multipass

docs/manual.md

@@ -75,6 +75,7 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use
 
 ## For Developers and Contributors
 * [Setting up a LibreTime instance with Vagrant](vagrant)
+* [Setting up a LibreTime instance with Multipass](multipass)
 * [Database access](database)
 * [Translating LibreTime](manual/interface-localization/index)
 

docs/multipass.md

@@ -0,0 +1,52 @@
+# Testing LibreTime with Canonical's Multipass
+
+Ever wanted to test out LibreTime but didn't want to tango with
+Virturalbox, Vagrent, or Docker?
+
+![](https://thumbs.gfycat.com/HauntingDirtyDragon-size_restricted.gif)
+
+Canonical released [Multipass](https://multipass.run), a tool for setting up Ubuntu VMs with cloud-init files in a snap.
+Multipass is available for Windows and macOS, as well as Linux OSes that support snaps.
+
+Similar to Docker, Multipass works through a CLI. To use, clone this repo and then open a Terminal
+(or Command Prompt) inside the `libretime` folder and run
+```
+multipass launch bionic -n ltTEST --cloud-init libretimeTest.yaml  # to launch VM
+multipass shell ltTEST  # to enter VM's shell
+```
+
+And that's it! At the moment, Multipass isn't patient enough for an automated install,
+so after you enter the shell for the first time, you will still need to run the install script for LibreTime.
+
+```
+sudo ./libretime/install -fiap
+
+sudo service airtime-liquidsoap start
+sudo service airtime-playout start
+sudo service airtime-celery start
+sudo service airtime_analyzer start
+```
+
+The IP address of your new VM can be found by running `multipass list`.
+Copy and paste it into your web browser to access the LibreTime interface.
+
+You can stop the VM with `multipass stop ltTEST` and restart with `multipass start ltTEST`.
+If you want to delete the image and start again, run `multipass delete ltTEST && multipass purge`.
+
+---
+### Cloud-init options in libretimeTest.yaml
+
+You may wish to change the below fields as per your location.
+```
+timezone: America/New York  # change as needed
+ntp:
+  pools: ['north-america.pool.ntp.org']
+  servers: ['0.north-america.pool.ntp.org', '0.pool.ntp.org']
+```
+
+If you are running your forked repo of LibreTime for testing purposes,
+modify the URL on this line:
+```
+runcmd:
+  - cd / && git clone https://github.com/LibreTime/libretime.git
+```

libretimeTest.yaml

@@ -0,0 +1,24 @@
+# Maintainer: Zachary Klosko (kloskoz@vcu.edu)
+
+hostname: libretimeTest
+timezone: America/New York  # change as needed
+ntp:
+  pools: ['north-america.pool.ntp.org']
+  servers: ['0.north-america.pool.ntp.org', '0.pool.ntp.org']
+
+password: hackme
+chpasswd: { expire: False }
+
+packages:
+  - git
+apt_update: true
+apt_upgrade: true
+
+
+runcmd:
+  - cd / && git clone https://github.com/LibreTime/libretime.git
+  # - sudo ./install -fiap  # not working yet, uncomment once Canonical fixes bugs in Multipass
+  # - service airtime-liquidsoap start
+  # - service airtime-playout start
+  # - service airtime-celery start
+  # - service airtime_analyzer start