diff --git a/docs/_config.yml b/docs/_config.yml index fa1d1f3fb..9a5377186 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,7 +1,7 @@ title: LibreTime description: An open source radio automation server made for (and by) low-power FM stations and the rest of us. logo: 144px.png -baseurl: "zklosko.github.io/libretime/" # The subpath of your site, e.g. /blog +baseurl: "" # The subpath of your site, e.g. /blog url: "https://libretime.org" # The base hostname & protocol for your site, e.g. http://example.com layouts_dir: _layouts diff --git a/docs/_docs/contribute.md b/docs/_docs/contribute.md index 8d17af009..908f0b80a 100644 --- a/docs/_docs/contribute.md +++ b/docs/_docs/contribute.md @@ -46,17 +46,17 @@ your desktop, open up a favorite editor and make some changes, and then commit, Knowledge on how to use [Github](https://guides.github.com/activities/hello-world/) and [Git](https://git-scm.com/docs/gittutorial) will suit you well, use the links for a quick 101. -### Testing LibreTime in Vagrant +## Testing LibreTime Before submitting code to the project, it's a good idea to test it first. To do this, it's easiest to install -LibreTime in a virtural machine on your local system or in a cloud VM. Instructions on how to set up a virtural -instance of LibreTime with Vagrant are located [here](/docs/vagrant). +LibreTime in a virtural machine on your local system or in a cloud VM. We have instructions for setting up a virtural +instance of LibreTime with [Vagrant](/docs/vagrant) and [Multipass](/docs/multipass). If you would like to try LibreTime in a Docker image, Odclive has instructions [here](https://github.com/kessibi/libretime-docker) for setting up a test image and a more persistant install. -### Modifying the Database +## Modifying the Database LibreTime is designed to work with a [PostgreSQL](https://www.postgresql.org/) database server running locally. LibreTime uses [PropelORM](http://propelorm.org) to interact with the ZendPHP components and create the database. diff --git a/docs/_docs/host-configuration.md b/docs/_docs/host-configuration.md index b09ab13e9..0889f93f8 100644 --- a/docs/_docs/host-configuration.md +++ b/docs/_docs/host-configuration.md @@ -267,11 +267,11 @@ If the server time zone is not appropriate for integration with your station's o This command opens a menu in which you can select the continent that you require, by pressing the Enter key. -![](img/Screenshot15-Configuring_tzdata.png) +![](/img/Screenshot15-Configuring_tzdata.png) The next step is to select your nearest city, again by pressing the Enter key. The appropriate time zone is selected according to the information that you have entered. -![](img/Screenshot16-Configure_city.png) +![](/img/Screenshot16-Configure_city.png) The console output from the **dpkg-reconfigure tzdata** command will confirm the new setting: diff --git a/docs/_docs/multipass.md b/docs/_docs/multipass.md new file mode 100644 index 000000000..fe2b9077d --- /dev/null +++ b/docs/_docs/multipass.md @@ -0,0 +1,43 @@ +--- +title: Multipass +layout: article +category: dev +--- + +[Multipass](https://multipass.run) is a tool for easily setting up Ubuntu VMs on Windows, Mac, and Linux. +Similar to Docker, Multipass works through a CLI. To use, clone this repo and then open a Terminal (or Command Prompt) inside the created folder and run + +``` +multipass launch bionic -n ltTEST --cloud-init multipass.yaml +multipass shell ltTEST +``` + +Multipass isn't currently able to do an automated install from the cloud-init script. +After you enter the shell for the first time, you will still need to run the install script for LibreTime. + +``` +sudo ./libretime/install -fiap +``` + +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 and complete the setup wizard. + +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: + +``` +- cd / && git clone https://github.com/LibreTime/libretime.git +``` \ No newline at end of file diff --git a/docs/_docs/station-setup.md b/docs/_docs/station-setup.md index 2376031d8..8df401914 100644 --- a/docs/_docs/station-setup.md +++ b/docs/_docs/station-setup.md @@ -7,8 +7,26 @@ category: manager ## How to ### 1. Prepare your studio -### 2. Install Ubuntu 18.04 LTS + +The server or desktop you plan to run Libretime on should have a built-in soundcard +and ethernet port. A wired approach is strongly recommended over a wireless one. + +### 2. Install Ubuntu Server 18.04 LTS + +Download Ubuntu Server [here](https://ubuntu.com/download/server) (look under Option 3). +A standard install is recommended, on a RAID 1 array if possible (not required, but recommended). + +Installation checklist: + +- Set correct timezone +- Sync system with national time servers +- Open firewall ports 80 and 8000 +- Enable the SSH server for easier remote access (optional) + ### 3. Install Libretime + +See the [install page](/install). + ### 4. Configure soundcard ### 5. Set up SSH tunneling (optional) diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 990f05361..334834bda 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -2,7 +2,7 @@
- Docs UI Kit + Libretime

LibreTime is an open source radio automation and broadcasting solution helping communities broadcast with ease.

diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 2a04fecbb..28c038fb2 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -12,6 +12,11 @@ + + + + + diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html index 380f446f3..08b15514c 100644 --- a/docs/_includes/navbar.html +++ b/docs/_includes/navbar.html @@ -16,6 +16,11 @@
  • Star on Github
    • +
  • + +
    • diff --git a/docs/_includes/scripts.html b/docs/_includes/scripts.html index 325e79025..f5e1c878c 100644 --- a/docs/_includes/scripts.html +++ b/docs/_includes/scripts.html @@ -40,4 +40,37 @@ e.preventDefault(); scrollToTop(); } - \ No newline at end of file + + + + + + \ No newline at end of file diff --git a/multipass.yml b/multipass.yml new file mode 100644 index 000000000..99286dd35 --- /dev/null +++ b/multipass.yml @@ -0,0 +1,20 @@ +# 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 + +# Clone repo on init (Change repo url if needed) +# If you need to clone a branch, use git clone --branch branchname repourl +runcmd: + - git clone https://github.com/LibreTime/libretime.git \ No newline at end of file