sintonia/docs/_site/quickstart.html

234 lines
9.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
<!-- Custom fonts for this template -->
<link href="vendor/fontawesome-free/css/all.min.css" rel="stylesheet" type="text/css">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Merriweather:400,300,300italic,400italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<!-- Plugin CSS -->
<link href="vendor/magnific-popup/magnific-popup.css" rel="stylesheet">
<!-- Custom styles for this template -->
<link href="css/creative.min.css" rel="stylesheet">
<style>
header.masthead {
padding-top: 10rem;
padding-bottom: calc(10rem - 56px);
background-image: url("img/header.jpg");
background-position: center center;
background-size: cover;
}
.bg-dark{
padding:2rem 0
}
</style>
<title>LibreTime Radio Automation - Quick Install</title>
</head>
<body id="page-top">
<!-- Navigation -->
<nav class="navbar navbar-expand-lg navbar-light fixed-top navbar-shrink" id="mainNav">
<div class="container">
<a class="navbar-brand js-scroll-trigger" href="index"> LibreTime Radio Automation </a>
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="quickstart">Install</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="features">Features</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="tour">Tour</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="faq">FAQ</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="advanced-configuration">Docs</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="contribute">Help Us!</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container-lg">
<nav class="content">
<html>
<head>
<style>
section{padding:4rem 0}
</style>
</head>
<body>
<section class="bg-primary">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto text-center">
<h2 class="section-heading text-white"> Quick Install </h2>
<hr class="light my-4">
<p class="text-faded mb-4">
LibreTime is quick and easy to install and get running. Follow this guide to go from zero to full internet radio station in 10 minutes!
</p>
</div>
</div>
</div>
</section>
<blockquote>
<p>Note: this guide is assuming you are using Ubuntu 18.04 LTS for installation, which comes with <code class="highlighter-rouge">ufw</code> and <code class="highlighter-rouge">netplan</code>,
and that you have already installed <code class="highlighter-rouge">git</code> and configured <code class="highlighter-rouge">ntp</code>. NTP configuration instructions can be found <a href="setting-the-server-time">here</a>.
While it is possible to install LibreTime on other OSes, such as CentOS 7, Debian 9 and 10, and Raspbian 9 and 10,
these are less tested. Firewall and static IP address configuration will need to be done according to your OSes instructions.</p>
</blockquote>
<h2 id="minimum-system-requirements">Minimum System Requirements</h2>
<table>
<thead>
<tr>
<th>On-Premises Install (FM + Internet Radio)</th>
<th>Cloud Install (Internet Radio Only)</th>
</tr>
</thead>
<tbody>
<tr>
<td>1 Ghz Processor</td>
<td>1vCPU</td>
</tr>
<tr>
<td>2 GB RAM</td>
<td>2 GB RAM</td>
</tr>
<tr>
<td>Wired ethernet connection and a static IP address (see below for instructions)</td>
<td>2 TB of data transfer/month</td>
</tr>
</tbody>
</table>
<p><a href="https://www.digitalocean.com/pricing/#Compute">DigitalOcean</a> and <a href="https://www.linode.com/pricing/#row--compute">Linode</a>
have similar plans that meet Cloud Install requirements. Both plans cost $10/month.</p>
<h2 id="preparing-the-server">Preparing the server</h2>
<p>Configure the server to have a static IP address by modifying the Netplan configuration.
If youre using a cloud VM, you likely already have a static IP address. Check with your provider to confirm this.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cd /etc/netplan &amp;&amp; ls # find the netplan filename
sudo nano ##-netcfg.yaml
</code></pre></div></div>
<p>If the Netplan configuration is empty, fill in the file with the example below. Otherwise,
input the IP address reserved for the server in <code class="highlighter-rouge">xxx.xxx.xxx.xxx/yy</code> format, the gateway (the IP address
of your router), and the DNS nameserver. If you dont have a nameserver on your network,
feel free to use Cloudflares: <code class="highlighter-rouge">1.1.1.1</code> and <code class="highlighter-rouge">1.0.0.1</code>.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>network:
version: 2
renderer: networkd
ethernets:
enp3s0:
addresses: [192.168.88.8/24]
gateway4: 192.168.88.1
nameservers:
addresses: 192.168.88.1
</code></pre></div></div>
<p>Next, configure Ubuntus firewall by running:</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>sudo ufw enable
sudo ufw allow 80/tcp
sudo ufw allow 8000/tcp
</code></pre></div></div>
<p>Unblock ports 8001 and 8002 if you plan on broadcasting live with Libretime.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>sudo ufw enable 8001/tcp
sudo ufw enable 8002/tcp
</code></pre></div></div>
<blockquote>
<p>If needed, instuctions for setting up a reverse proxy can be found <a href="reverse-proxy">here</a>.</p>
</blockquote>
<h2 id="installing-libretime">Installing LibreTime</h2>
<p>Installing LibreTime consists of running the following commands in the terminal:</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>git clone https://github.com/LibreTime/libretime.git
cd libretime
sudo ./install -fiap
</code></pre></div></div>
<p>After the install is completed, head to the IP address of the server LibreTime was just installed on
to complete the welcome wizard. While not strictly necessary, it is recommended that you change the passwords prompted in the welcome wizard if you intend on accessing the server from the Internet. The welcome wizard will
walk you through the rest of the installation process.</p>
<p>Congratulations! Youve successfully set up LibreTime!</p>
<h2 id="post-install">Post-install</h2>
<p>If you plan to have LibreTime output analog audio directly from its server to a mixing console or transmitter,
the <code class="highlighter-rouge">www-data</code> user needs to be added to the <code class="highlighter-rouge">audio</code> user group using the command below.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>sudo adduser www-data audio
</code></pre></div></div>
<p>Now that the install is complete, use these guides to help you continue to set up your LibreTime server</p>
<ul>
<li><a href="host-configuration">Host Configuration</a></li>
<li><a href="setting-the-server-time">Setting the Server Time</a></li>
<li><a href="track-types">Configuring Track Types</a></li>
<li><a href="ssl-config">Setting up SSL</a></li>
</ul>
</body>
</html>
</nav>
</div>
<footer>
<section class="bg-dark text-white">
<div class="text-footer">
<small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/ned-kelly">ned-kelly</a> and <a href="https://github.com/zklosko">Zachary Klosko</a> &nbsp; | &nbsp;</small>
<small>Code and docs licensed under GPLv2. More details <a href="http://sourcefabric.booktype.pro/airtime-25-for-broadcasters/about-this-manual/">here</a>. </small>
</div>
</section>
</footer>
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
</body>
</html>