free
/
freedombonee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
freedombonee/website/EN/app_koel.html

401 lines
15 KiB
HTML
Raw Normal View History

Start of koel documentation
2017-05-25 20:37:49 +02:00
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
Link to site
2017-05-25 23:48:11 +02:00
<!-- 2017-05-25 Thu 22:48 -->
Start of koel documentation
2017-05-25 20:37:49 +02:00
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Bob Mottram" />
<meta name="description" content="How to use Koel"
/>
<meta name="keywords" content="freedombone, koel, music" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<link rel="stylesheet" type="text/css" href="freedombone.css" />
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2017 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="preamble" class="status">
<a name="top" id="top"></a>
</div>
<div id="content">
<div class="org-center">
<div class="figure">
<p><img src="images/logo.png" alt="logo.png" />
</p>
</div>
</div>
<center>
<h1>Koel</h1>
</center>
<p>
Link to site
2017-05-25 23:48:11 +02:00
This enables you to store your music on the Freedombone server and then access it from any internet connected device. If you just want to make music accessible within your home network then <a href="./app_dlna.html">DLNA</a> is usually sufficient, but if you want to be able to play your music from anywhere then <a href="https://koel.phanan.net">Koel</a> is a better option.
Start of koel documentation
2017-05-25 20:37:49 +02:00
</p>
<div class="org-center">
<div class="figure">
<p><img src="images/koel.jpg" alt="koel.jpg" />
</p>
</div>
</div>
Link to site
2017-05-25 23:48:11 +02:00
<div id="outline-container-org00818ff" class="outline-2">
<h2 id="org00818ff">Installation</h2>
<div class="outline-text-2" id="text-org00818ff">
Start of koel documentation
2017-05-25 20:37:49 +02:00
<p>
Log into your system with:
</p>
<div class="org-src-container">
<pre><code class="src src-bash">ssh myusername@mydomain -p 2222
</code></pre>
</div>
<p>
Using cursor keys, space bar and Enter key select <b>Administrator controls</b> and type in your password.
</p>
<p>
Select <b>Add/Remove Apps</b> then <b>koel</b>. You will then be asked for a domain name and if you are using FreeDNS also the code for the domain which can be found under <b>Dynamic DNS</b> on the FreeDNS site (the random string from "<i>quick cron example</i>" which appears after <i>update.php?</i> and before <i>&gt;&gt;</i>). For more details on obtaining a domain and making it accessible via dynamic DNS see the <a href="./faq.html">FAQ</a>. Typically the domain name you use will be a subdomain, such as <i>music.mydomainname.net</i>. It will need to be a domain which you have bought somewhere and own and not one of the FreeDNS subdomains, otherwise you won't be able to get a SSL/TLS certificate for it.
</p>
<p>
Go back to the <b>Administrator control panel</b>, select <b>Passwords</b> then <b>koel</b>. You can then use this password together with your email address to initially log in.
</p>
<p>
Once logged in go to settings and set the media path to <b>/music</b>.
</p>
<div class="org-center">
<div class="figure">
<p><img src="images/koelsettings.jpg" alt="koelsettings.jpg" />
</p>
</div>
</div>
</div>
</div>
Link to site
2017-05-25 23:48:11 +02:00
<div id="outline-container-org9c20e8e" class="outline-2">
<h2 id="org9c20e8e">Importing music</h2>
<div class="outline-text-2" id="text-org9c20e8e">
Document importing music
2017-05-25 23:43:45 +02:00
<p>
This app doesn't have any way to upload music and instead just expects that there will be a directory on the server containing music files. There are a couple of ways to get new music files onto the system: either by using ssh or by putting them onto a USB drive.
</p>
<div class="org-center">
<div class="figure">
<p><img src="images/controlpanel/control_panel_koel.jpg" alt="control_panel_koel.jpg" />
</p>
</div>
</div>
</div>
Link to site
2017-05-25 23:48:11 +02:00
<div id="outline-container-orga173c5d" class="outline-3">
<h3 id="orga173c5d">Via ssh</h3>
<div class="outline-text-3" id="text-orga173c5d">
Document importing music
2017-05-25 23:43:45 +02:00
<p>
On your local system:
</p>
<div class="org-src-container">
<pre><code class="src src-bash">scp -P 2222 -r ~/Music username@domainname:/home/username
</code></pre>
</div>
<p>
This will copy anything files in your local Music directory to your home directory on the Freedombone system.
</p>
<p>
Now log in to your Freedombone system:
</p>
<div class="org-src-container">
<pre><code class="src src-bash">ssh username@domainname -p 2222
</code></pre>
</div>
<p>
And select <b>Administrator settings</b> followed by <b>App settings</b> then <b>koel</b>. Select <b>Import music from directory</b> then using up and down cursors select the directory and <b>press space</b> so that it appears in the selection box below. Select <b>Ok</b> and then the files will be moved to their final destination in the <b>/music</b> directory.
</p>
</div>
</div>
Link to site
2017-05-25 23:48:11 +02:00
<div id="outline-container-org7e8ad46" class="outline-3">
<h3 id="org7e8ad46">Via USB drive</h3>
<div class="outline-text-3" id="text-org7e8ad46">
Document importing music
2017-05-25 23:43:45 +02:00
<p>
Create a LUKS formatted USB drive. It's possible to do this by plugging a new USB drive into the Freedombone system then going to the <b>Administrator control panel</b>, selecting <b>App settings</b> then <b>koel</b> then <b>Format a USB drive</b>. You will need to specify a password, which in this case doesn't need to be anything highly secure.
</p>
<p>
Once the drive if formatted you can remove it and copy Music files onto it from other systems. Make sure the files are contained within a directory named <b>Music</b>.
</p>
<p>
Once you have music on a LUKS formatted USB drive then plug it into the Freedombone system. Go to the <b>Administrator control panel</b>, select <b>App settings</b> then <b>koel</b> then <b>Import music from USB drive</b>. Enter the password you used to create the drive and music files will then be copied.
</p>
</div>
</div>
Link to site
2017-05-25 23:48:11 +02:00
<div id="outline-container-org8df6a4e" class="outline-3">
<h3 id="org8df6a4e">Synchronizing</h3>
<div class="outline-text-3" id="text-org8df6a4e">
Document importing music
2017-05-25 23:43:45 +02:00
<p>
To detect the imported files you might need to re-synchronize. Within Koel go to settings and then select <b>Scan</b>. Any imported files should then be available to play.
</p>
</div>
</div>
Start of koel documentation
2017-05-25 20:37:49 +02:00
</div>
</div>
<div id="postamble" class="status">
<style type="text/css">
.back-to-top {
position: fixed;
bottom: 2em;
right: 0px;
text-decoration: none;
color: #000000;
background-color: rgba(235, 235, 235, 0.80);
font-size: 12px;
padding: 1em;
display: none;
}
.back-to-top:hover {
background-color: rgba(135, 135, 135, 0.50);
}
</style>
<div class="back-to-top">
<a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
</div>
</div>
</body>
</html>