mirror of
https://github.com/owntone/owntone-server.git
synced 2024-12-24 06:05:56 -05:00
[docs] Split docs into multiple files and publish with gh-actions
This commit is contained in:
chme
parent
f991d9ddf9
commit
b5dcc04b2d
16
.github/workflows/gh-pages.yml
vendored
Normal file
16
.github/workflows/gh-pages.yml
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
name: build and deploy mkdocs to github pages
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.x
|
||||
- run: pip install mkdocs-material
|
||||
- run: pip install mkdocs-minify-plugin
|
||||
- run: mkdocs gh-deploy --force
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@ -43,3 +43,6 @@ debian/
|
||||
/.project
|
||||
/.autotools
|
||||
/.vscode
|
||||
|
||||
# ignore MkDocs generated documentation
|
||||
/site/
|
||||
|
||||
26
Makefile.am
26
Makefile.am
@ -23,14 +23,30 @@ dist_man_MANS = owntone.8
|
||||
nobase_dist_doc_DATA = \
|
||||
UPGRADING \
|
||||
README.md \
|
||||
docs/playlists.md \
|
||||
docs/integrations/spotify.md \
|
||||
docs/integrations/lastfm.md \
|
||||
docs/index.md \
|
||||
docs/documentation.md \
|
||||
docs/outputs/streaming.md \
|
||||
docs/outputs/chromecast.md \
|
||||
docs/outputs/airplay.md \
|
||||
docs/outputs/local-audio.md \
|
||||
docs/installation.md \
|
||||
docs/outputs-pulse.md \
|
||||
docs/outputs-alsa.md \
|
||||
docs/clients/web-interface.md \
|
||||
docs/clients/remote.md \
|
||||
docs/clients/cli.md \
|
||||
docs/clients/supported-clients.md \
|
||||
docs/clients/mpd.md \
|
||||
docs/smart-playlists.md \
|
||||
docs/web-interface.md \
|
||||
docs/radio-streams.md \
|
||||
docs/artwork.md \
|
||||
docs/library.md \
|
||||
docs/getting-started.md \
|
||||
docs/advanced/radio-streams.md \
|
||||
docs/advanced/multiple-instances.md \
|
||||
docs/advanced/outputs-alsa.md \
|
||||
docs/advanced/remote-access.md \
|
||||
docs/advanced/outputs-pulse.md \
|
||||
docs/json-api.md \
|
||||
scripts/pairinghelper.sh
|
||||
|
||||
EXTRA_DIST = \
|
||||
|
||||
25
docs/advanced/multiple-instances.md
Normal file
25
docs/advanced/multiple-instances.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Running Multiple Instances
|
||||
|
||||
To run multiple instances of owntone on a server, you should copy
|
||||
`/etc/owntone.conf` to `/etc/owntone-zone.conf` (for each `zone`) and
|
||||
modify the following to be unique across all instances:
|
||||
|
||||
* the three port settings (`general` -> `websocket_port`,
|
||||
`library` -> `port`, and `mpd` -> `port`)
|
||||
|
||||
* the database paths (`general` -> `db_path`, `db_backup_path`, and `db_cache_path`)
|
||||
|
||||
* the service name (`library` -> `name`).
|
||||
|
||||
* you probably also want to disable local output (set `audio` -> `type =
|
||||
"disabled"`).
|
||||
|
||||
Then run `owntone -c /etc/owntone-zone.conf` to run owntone with the new
|
||||
zone configuration.
|
||||
|
||||
Owntone has a `systemd` template which lets you run this automatically
|
||||
on systems that use systemd. You can start or enable the service for
|
||||
a `zone` by `sudo systemctl start owntone@zone` and check that it is
|
||||
running with `sudo systemctl status owntone@zone`. Use `sudo
|
||||
systemctl enable ownton@zone` to get the service to start on reboot.
|
||||
|
||||
21
docs/advanced/remote-access.md
Normal file
21
docs/advanced/remote-access.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Remote access
|
||||
|
||||
It is possible to access a shared library over the internet from a DAAP client
|
||||
like iTunes. You must have remote access to the host machine.
|
||||
|
||||
First log in to the host and forward port 3689 to your local machine. You now
|
||||
need to broadcast the daap service to iTunes on your local machine. On macOS the
|
||||
command is:
|
||||
|
||||
```
|
||||
dns-sd -P iTunesServer _daap._tcp local 3689 localhost.local 127.0.0.1 "ffid=12345"
|
||||
```
|
||||
|
||||
The `ffid` key is required but its value does not matter.
|
||||
|
||||
Your library will now appear as 'iTunesServer' in iTunes.
|
||||
|
||||
You can also access your library remotely using something like Zerotier. See [this
|
||||
guide](https://github.com/owntone/owntone-server/wiki/Accessing-Owntone-remotely-through-iTunes-Music-with-Zerotier)
|
||||
for details.
|
||||
|
||||
34
docs/artwork.md
Normal file
34
docs/artwork.md
Normal file
@ -0,0 +1,34 @@
|
||||
# Artwork
|
||||
|
||||
OwnTone has support for PNG and JPEG artwork which is either:
|
||||
|
||||
- embedded in the media files
|
||||
- placed as separate image files in the library
|
||||
- made available online by the radio station
|
||||
|
||||
For media in your library, OwnTone will try to locate album and artist
|
||||
artwork (group artwork) by the following procedure:
|
||||
|
||||
- if a file {artwork,cover,Folder}.{png,jpg} is found in one of the directories
|
||||
containing files that are part of the group, it is used as the artwork. The
|
||||
first file found is used, ordering is not guaranteed;
|
||||
- failing that, if [directory name].{png,jpg} is found in one of the
|
||||
directories containing files that are part of the group, it is used as the
|
||||
artwork. The first file found is used, ordering is not guaranteed;
|
||||
- failing that, individual files are examined and the first file found
|
||||
with an embedded artwork is used. Here again, ordering is not guaranteed.
|
||||
|
||||
{artwork,cover,Folder} are the default, you can add other base names in the
|
||||
configuration file. Here you can also enable/disable support for individual
|
||||
file artwork (instead of using the same artwork for all tracks in an entire
|
||||
album).
|
||||
|
||||
For playlists in your library, say /foo/bar.m3u, then for any http streams in
|
||||
the list, OwnTone will look for /foo/bar.{jpg,png}.
|
||||
|
||||
You can use symlinks for the artwork files.
|
||||
|
||||
OwnTone caches artwork in a separate cache file. The default path is
|
||||
`/var/cache/owntone/cache.db` and can be configured in the configuration
|
||||
file. The cache.db file can be deleted without losing the library and pairing
|
||||
informations.
|
||||
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 454 KiB After Width: | Height: | Size: 454 KiB |
|
Before Width: | Height: | Size: 130 KiB After Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 458 KiB After Width: | Height: | Size: 458 KiB |
|
Before Width: | Height: | Size: 107 KiB After Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 492 KiB After Width: | Height: | Size: 492 KiB |
|
Before Width: | Height: | Size: 507 KiB After Width: | Height: | Size: 507 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
|
Before Width: | Height: | Size: 354 KiB After Width: | Height: | Size: 354 KiB |
|
Before Width: | Height: | Size: 406 KiB After Width: | Height: | Size: 406 KiB |
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 124 KiB After Width: | Height: | Size: 124 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
25
docs/clients/cli.md
Normal file
25
docs/clients/cli.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Command line
|
||||
|
||||
You can choose between:
|
||||
|
||||
- a [MPD command line client](#mpd-clients) (easiest) like `mpc`
|
||||
- curl with OwnTone's JSON API (see [README_JSON_API.md](https://github.com/owntone/owntone-server/blob/master/README_JSON_API.md))
|
||||
- curl with DAAP/DACP commands (hardest)
|
||||
|
||||
Here is an example of how to use curl with DAAP/DACP. Say you have a playlist
|
||||
with a radio station, and you want to make a script that starts playback of that
|
||||
station:
|
||||
|
||||
1. Run `sqlite3 [your OwnTone db]`. Use `select id,title from files` to get
|
||||
the id of the radio station, and use `select id,title from playlists` to get
|
||||
the id of the playlist.
|
||||
2. Convert the two ids to hex.
|
||||
3. Put the following lines in the script with the relevant ids inserted (also
|
||||
observe that you must use a session-id < 100, and that you must login and
|
||||
logout):
|
||||
|
||||
```
|
||||
curl "http://localhost:3689/login?pairing-guid=0x1&request-session-id=50"
|
||||
curl "http://localhost:3689/ctrl-int/1/playspec?database-spec='dmap.persistentid:0x1'&container-spec='dmap.persistentid:0x[PLAYLIST-ID]'&container-item-spec='dmap.containeritemid:0x[FILE ID]'&session-id=50"
|
||||
curl "http://localhost:3689/logout?session-id=50"
|
||||
```
|
||||
24
docs/clients/mpd.md
Normal file
24
docs/clients/mpd.md
Normal file
@ -0,0 +1,24 @@
|
||||
# MPD clients
|
||||
|
||||
You can - to some extent - use clients for MPD to control OwnTone.
|
||||
|
||||
By default OwnTone listens on port 6600 for MPD clients. You can change
|
||||
this in the configuration file.
|
||||
|
||||
Currently only a subset of the commands offered by MPD (see [MPD protocol documentation](http://www.musicpd.org/doc/protocol/))
|
||||
are supported.
|
||||
|
||||
Due to some differences between OwnTone and MPD not all commands will act the
|
||||
same way they would running MPD:
|
||||
|
||||
- crossfade, mixrampdb, mixrampdelay and replaygain will have no effect
|
||||
- single, repeat: unlike MPD, OwnTone does not support setting single and repeat separately
|
||||
on/off, instead repeat off, repeat all and repeat single are supported. Thus setting single on
|
||||
will result in repeat single, repeat on results in repeat all.
|
||||
|
||||
The following table shows what is working for a selection of MPD clients:
|
||||
|
||||
| Client | Type | Status |
|
||||
| --------------------------------------------- | ------ | --------------- |
|
||||
| [mpc](http://www.musicpd.org/clients/mpc/) | CLI | Working commands: mpc, add, crop, current, del (ranges are not yet supported), play, next, prev (behaves like cdprev), pause, toggle, cdprev, seek, clear, outputs, enable, disable, playlist, ls, load, volume, repeat, random, single, search, find, list, update (initiates an init-rescan, the path argument is not supported) |
|
||||
| [ympd](http://www.ympd.org/) | Web | Everything except "add stream" should work |
|
||||
66
docs/clients/remote.md
Normal file
66
docs/clients/remote.md
Normal file
@ -0,0 +1,66 @@
|
||||
# Using Remote
|
||||
|
||||
Remote gets a list of output devices from the server; this list includes any
|
||||
and all devices on the network we know of that advertise AirPlay: AirPort
|
||||
Express, Apple TV, ... It also includes the local audio output, that is, the
|
||||
sound card on the server (even if there is no soundcard).
|
||||
|
||||
OwnTone remembers your selection and the individual volume for each
|
||||
output device; selected devices will be automatically re-selected, except if
|
||||
they return online during playback.
|
||||
|
||||
## Pairing
|
||||
|
||||
1. Open the [web interface](http://owntone.local:3689)
|
||||
2. Start Remote, go to Settings, Add Library
|
||||
3. Enter the pair code in the web interface (update the page with F5 if it does
|
||||
not automatically pick up the pairing request)
|
||||
|
||||
If Remote doesn't connect to OwnTone after you entered the pairing code
|
||||
something went wrong. Check the log file to see the error message. Here are
|
||||
some common reasons:
|
||||
|
||||
- You did not enter the correct pairing code
|
||||
|
||||
You will see an error in the log about pairing failure with a HTTP response code
|
||||
that is *not* 0.
|
||||
|
||||
Solution: Try again.
|
||||
|
||||
- No response from Remote, possibly a network issue
|
||||
|
||||
If you see an error in the log with either:
|
||||
|
||||
- a HTTP response code that is 0
|
||||
- "Empty pairing request callback"
|
||||
|
||||
it means that OwnTone could not establish a connection to Remote. This
|
||||
might be a network issue, your router may not be allowing multicast between the
|
||||
Remote device and the host OwnTone is running on.
|
||||
|
||||
Solution 1: Sometimes it resolves the issue if you force Remote to quit, restart
|
||||
it and do the pairing proces again. Another trick is to establish some other
|
||||
connection (eg SSH) from the iPod/iPhone/iPad to the host.
|
||||
|
||||
Solution 2: Check your router settings if you can whitelist multicast addresses
|
||||
under IGMP settings. For Apple Bonjour, setting a multicast address of
|
||||
224.0.0.251 and a netmask of 255.255.255.255 should work.
|
||||
|
||||
- Otherwise try using avahi-browse for troubleshooting:
|
||||
|
||||
- in a terminal, run `avahi-browse -r -k _touch-remote._tcp`
|
||||
- start Remote, goto Settings, Add Library
|
||||
- after a couple seconds at most, you should get something similar to this:
|
||||
|
||||
```
|
||||
+ ath0 IPv4 59eff13ea2f98dbbef6c162f9df71b784a3ef9a3 _touch-remote._tcp local
|
||||
= ath0 IPv4 59eff13ea2f98dbbef6c162f9df71b784a3ef9a3 _touch-remote._tcp local
|
||||
hostname = [Foobar.local]
|
||||
address = [192.168.1.1]
|
||||
port = [49160]
|
||||
txt = ["DvTy=iPod touch" "RemN=Remote" "txtvers=1" "RemV=10000" "Pair=FAEA410630AEC05E" "DvNm=Foobar"]
|
||||
```
|
||||
|
||||
Hit Ctrl-C to terminate avahi-browse.
|
||||
|
||||
- To check for network issues you can try to connect to address and port with telnet.
|
||||
43
docs/clients/supported-clients.md
Normal file
43
docs/clients/supported-clients.md
Normal file
@ -0,0 +1,43 @@
|
||||
# Supported clients
|
||||
|
||||
OwnTone supports these kinds of clients:
|
||||
|
||||
- DAAP clients, like iTunes or Rhythmbox
|
||||
- Remote clients, like Apple Remote or compatibles for Android/Windows Phone
|
||||
- AirPlay devices, like AirPort Express, Shairport and various AirPlay speakers
|
||||
- Chromecast devices
|
||||
- MPD clients, like mpc (see [mpd-clients](#mpd-clients))
|
||||
- MP3 network stream clients, like VLC and almost any other music player
|
||||
- RSP clients, like Roku Soundbridge
|
||||
|
||||
Like iTunes, you can control OwnTone with Remote and stream your music to
|
||||
AirPlay devices.
|
||||
|
||||
A single OwnTone instance can handle several clients concurrently, regardless of
|
||||
the protocol.
|
||||
|
||||
By default all clients on 192.168.* (and the ipv6 equivalent) are allowed to
|
||||
connect without authentication. You can change that in the configuration file.
|
||||
|
||||
Here is a list of working and non-working DAAP and Remote clients. The list is
|
||||
probably obsolete when you read it :-)
|
||||
|
||||
| Client | Developer | Type | Platform | Working (vers.) |
|
||||
| ------------------------ | ----------- | ------ | ------------- | --------------- |
|
||||
| iTunes | Apple | DAAP | Win | Yes (12.10.1) |
|
||||
| Apple Music | Apple | DAAP | MacOS | Yes |
|
||||
| Rhythmbox | Gnome | DAAP | Linux | Yes |
|
||||
| Diapente | diapente | DAAP | Android | Yes |
|
||||
| WinAmp DAAPClient | WardFamily | DAAP | WinAmp | Yes |
|
||||
| Amarok w/DAAP plugin | KDE | DAAP | Linux/Win | Yes (2.8.0) |
|
||||
| Banshee | | DAAP | Linux/Win/OSX | No (2.6.2) |
|
||||
| jtunes4 | | DAAP | Java | No |
|
||||
| Firefly Client | | (DAAP) | Java | No |
|
||||
| Remote | Apple | Remote | iOS | Yes (4.3) |
|
||||
| Retune | SquallyDoc | Remote | Android | Yes (3.5.23) |
|
||||
| TunesRemote+ | Melloware | Remote | Android | Yes (2.5.3) |
|
||||
| Remote for iTunes | Hyperfine | Remote | Android | Yes |
|
||||
| Remote for Windows Phone | Komodex | Remote | Windows Phone | Yes (2.2.1.0) |
|
||||
| TunesRemote SE | | Remote | Java | Yes (r108) |
|
||||
| rtRemote for Windows | bizmodeller | Remote | Windows | Yes (1.2.0.67) |
|
||||
|
||||
@ -3,25 +3,31 @@
|
||||
Mobile friendly player web interface for [OwnTone](http://owntone.github.io/owntone-server/) build
|
||||
with [Vue.js](https://vuejs.org), [Bulma](http://bulma.io).
|
||||
|
||||
You can find the web interface at [http://owntone.local:3689](http://owntone.local:3689)
|
||||
or alternatively at [http://[your_server_address_here]:3689](http://[your_server_address_here]:3689).
|
||||
|
||||
Use the web interface to control playback, trigger manual library rescans, pair
|
||||
with remotes, select speakers, authenticate with Spotify, etc.
|
||||
|
||||
## Screenshots
|
||||
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
|
||||
|
||||
## Usage
|
||||
@ -1,575 +0,0 @@
|
||||
# Documentation
|
||||
|
||||
## Getting started
|
||||
|
||||
After installation (see [Installation](installation.md)) do the following:
|
||||
|
||||
1. Edit the configuration file (usually `/etc/owntone.conf`) to suit your
|
||||
needs
|
||||
2. Start or restart the server (usually `/etc/init.d/owntone restart`)
|
||||
3. Go to the web interface [http://owntone.local:3689](http://owntone.local:3689),
|
||||
or, if that won't work, to [http://[your_server_address_here]:3689](http://[your_server_address_here]:3689)
|
||||
4. Wait for the library scan to complete
|
||||
5. If you will be using a remote, e.g. Apple Remote: Start the remote, go to
|
||||
Settings, Add Library
|
||||
6. Enter the pair code in the web interface (update the page with F5 if it does
|
||||
not automatically pick up the pairing request)
|
||||
|
||||
|
||||
## Supported clients
|
||||
|
||||
OwnTone supports these kinds of clients:
|
||||
|
||||
- DAAP clients, like iTunes or Rhythmbox
|
||||
- Remote clients, like Apple Remote or compatibles for Android/Windows Phone
|
||||
- AirPlay devices, like AirPort Express, Shairport and various AirPlay speakers
|
||||
- Chromecast devices
|
||||
- MPD clients, like mpc (see [mpd-clients](#mpd-clients))
|
||||
- MP3 network stream clients, like VLC and almost any other music player
|
||||
- RSP clients, like Roku Soundbridge
|
||||
|
||||
Like iTunes, you can control OwnTone with Remote and stream your music to
|
||||
AirPlay devices.
|
||||
|
||||
A single OwnTone instance can handle several clients concurrently, regardless of
|
||||
the protocol.
|
||||
|
||||
By default all clients on 192.168.* (and the ipv6 equivalent) are allowed to
|
||||
connect without authentication. You can change that in the configuration file.
|
||||
|
||||
Here is a list of working and non-working DAAP and Remote clients. The list is
|
||||
probably obsolete when you read it :-)
|
||||
|
||||
| Client | Developer | Type | Platform | Working (vers.) |
|
||||
| ------------------------ | ----------- | ------ | ------------- | --------------- |
|
||||
| iTunes | Apple | DAAP | Win | Yes (12.10.1) |
|
||||
| Apple Music | Apple | DAAP | MacOS | Yes |
|
||||
| Rhythmbox | Gnome | DAAP | Linux | Yes |
|
||||
| Diapente | diapente | DAAP | Android | Yes |
|
||||
| WinAmp DAAPClient | WardFamily | DAAP | WinAmp | Yes |
|
||||
| Amarok w/DAAP plugin | KDE | DAAP | Linux/Win | Yes (2.8.0) |
|
||||
| Banshee | | DAAP | Linux/Win/OSX | No (2.6.2) |
|
||||
| jtunes4 | | DAAP | Java | No |
|
||||
| Firefly Client | | (DAAP) | Java | No |
|
||||
| Remote | Apple | Remote | iOS | Yes (4.3) |
|
||||
| Retune | SquallyDoc | Remote | Android | Yes (3.5.23) |
|
||||
| TunesRemote+ | Melloware | Remote | Android | Yes (2.5.3) |
|
||||
| Remote for iTunes | Hyperfine | Remote | Android | Yes |
|
||||
| Remote for Windows Phone | Komodex | Remote | Windows Phone | Yes (2.2.1.0) |
|
||||
| TunesRemote SE | | Remote | Java | Yes (r108) |
|
||||
| rtRemote for Windows | bizmodeller | Remote | Windows | Yes (1.2.0.67) |
|
||||
|
||||
|
||||
## Web interface
|
||||
|
||||
You can find the web interface at [http://owntone.local:3689](http://owntone.local:3689)
|
||||
or alternatively at [http://[your_server_address_here]:3689](http://[your_server_address_here]:3689).
|
||||
|
||||
Use the web interface to control playback, trigger manual library rescans, pair
|
||||
with remotes, select speakers, authenticate with Spotify, etc.
|
||||
|
||||
You can find some screenshots and build instructions in the [web interface documentation](web-interface.md).
|
||||
|
||||
## Using Remote
|
||||
|
||||
Remote gets a list of output devices from the server; this list includes any
|
||||
and all devices on the network we know of that advertise AirPlay: AirPort
|
||||
Express, Apple TV, ... It also includes the local audio output, that is, the
|
||||
sound card on the server (even if there is no soundcard).
|
||||
|
||||
OwnTone remembers your selection and the individual volume for each
|
||||
output device; selected devices will be automatically re-selected, except if
|
||||
they return online during playback.
|
||||
|
||||
### Pairing
|
||||
|
||||
1. Open the [web interface](http://owntone.local:3689)
|
||||
2. Start Remote, go to Settings, Add Library
|
||||
3. Enter the pair code in the web interface (update the page with F5 if it does
|
||||
not automatically pick up the pairing request)
|
||||
|
||||
If Remote doesn't connect to OwnTone after you entered the pairing code
|
||||
something went wrong. Check the log file to see the error message. Here are
|
||||
some common reasons:
|
||||
|
||||
- You did not enter the correct pairing code
|
||||
|
||||
You will see an error in the log about pairing failure with a HTTP response code
|
||||
that is *not* 0.
|
||||
|
||||
Solution: Try again.
|
||||
|
||||
- No response from Remote, possibly a network issue
|
||||
|
||||
If you see an error in the log with either:
|
||||
|
||||
- a HTTP response code that is 0
|
||||
- "Empty pairing request callback"
|
||||
|
||||
it means that OwnTone could not establish a connection to Remote. This
|
||||
might be a network issue, your router may not be allowing multicast between the
|
||||
Remote device and the host OwnTone is running on.
|
||||
|
||||
Solution 1: Sometimes it resolves the issue if you force Remote to quit, restart
|
||||
it and do the pairing proces again. Another trick is to establish some other
|
||||
connection (eg SSH) from the iPod/iPhone/iPad to the host.
|
||||
|
||||
Solution 2: Check your router settings if you can whitelist multicast addresses
|
||||
under IGMP settings. For Apple Bonjour, setting a multicast address of
|
||||
224.0.0.251 and a netmask of 255.255.255.255 should work.
|
||||
|
||||
- Otherwise try using avahi-browse for troubleshooting:
|
||||
|
||||
- in a terminal, run `avahi-browse -r -k _touch-remote._tcp`
|
||||
- start Remote, goto Settings, Add Library
|
||||
- after a couple seconds at most, you should get something similar to this:
|
||||
|
||||
```
|
||||
+ ath0 IPv4 59eff13ea2f98dbbef6c162f9df71b784a3ef9a3 _touch-remote._tcp local
|
||||
= ath0 IPv4 59eff13ea2f98dbbef6c162f9df71b784a3ef9a3 _touch-remote._tcp local
|
||||
hostname = [Foobar.local]
|
||||
address = [192.168.1.1]
|
||||
port = [49160]
|
||||
txt = ["DvTy=iPod touch" "RemN=Remote" "txtvers=1" "RemV=10000" "Pair=FAEA410630AEC05E" "DvNm=Foobar"]
|
||||
```
|
||||
|
||||
Hit Ctrl-C to terminate avahi-browse.
|
||||
|
||||
- To check for network issues you can try to connect to address and port with telnet.
|
||||
|
||||
|
||||
## AirPlay devices/speakers
|
||||
|
||||
OwnTone will discover the AirPlay devices available on your network. For
|
||||
devices that are password-protected, the device's AirPlay name and password
|
||||
must be given in the configuration file. See the sample configuration file
|
||||
for the syntax.
|
||||
|
||||
If your Apple TV requires device verification (always required by Apple TV4 with
|
||||
tvOS 10.2) then you can do that through Settings > Remotes & Outputs in the web
|
||||
interface: Select the device and then enter the PIN that the Apple TV displays.
|
||||
|
||||
If your speaker is silent when you start playback, and there is no obvious error
|
||||
message in the log, you can try disabling ipv6 in the config. Some speakers
|
||||
announce that they support ipv6, but in fact don't (at least not with forked-
|
||||
daapd).
|
||||
|
||||
If the speaker becomes unselected when you start playback, and you in the log
|
||||
see "ANNOUNCE request failed in session startup: 400 Bad Request", then try
|
||||
the Apple Home app > Allow Speakers & TV Access > Anyone On the Same Network
|
||||
(or Everyone).
|
||||
|
||||
|
||||
## Chromecast
|
||||
|
||||
OwnTone will discover Chromecast devices available on your network, and you
|
||||
can then select the device as a speaker. There is no configuration required.
|
||||
|
||||
|
||||
## Local audio through ALSA
|
||||
|
||||
In the config file, you can select ALSA for local audio. This is the default.
|
||||
|
||||
When using ALSA, the server will try to syncronize playback with AirPlay. You
|
||||
can adjust the syncronization in the config file.
|
||||
|
||||
For most setups the default values in the config file should work. If they
|
||||
don't, there is help [here](outputs-alsa.md)
|
||||
|
||||
|
||||
## Local audio, Bluetooth and more through Pulseaudio
|
||||
|
||||
In the config file, you can select Pulseaudio for local audio. In addition to
|
||||
local audio, Pulseaudio also supports an array of other targets, e.g. Bluetooth
|
||||
or DLNA. However, Pulseaudio does require some setup, so here is a separate page
|
||||
with some help on that: [Pulse audio](outputs-pulse.md)
|
||||
|
||||
Note that if you select Pulseaudio the "card" setting in the config file has
|
||||
no effect. Instead all soundcards detected by Pulseaudio will be listed as
|
||||
speakers by OwnTone.
|
||||
|
||||
You can adjust the latency of Pulseaudio playback in the config file.
|
||||
|
||||
|
||||
## MP3 network streaming (streaming to iOS)
|
||||
|
||||
You can listen to audio being played by OwnTone by opening this network
|
||||
stream address in pretty much any music player:
|
||||
|
||||
http://[your hostname/ip address]:3689/stream.mp3
|
||||
|
||||
This is currently the only way of listening to your audio on iOS devices, since
|
||||
Apple does not allow AirPlay receiver apps, and because Apple Home Sharing
|
||||
cannot be supported by OwnTone. So what you can do instead is install a
|
||||
music player app like VLC, connect to the stream and control playback with
|
||||
Remote.
|
||||
|
||||
In the speaker selection list, clicking on the icon should start the stream
|
||||
playing in the background on browsers that support that.
|
||||
|
||||
Note that MP3 encoding must be supported by ffmpeg/libav for this to work. If
|
||||
it is not available you will see a message in the log file. In Debian/Ubuntu you
|
||||
get MP3 encoding support by installing the package "libavcodec-extra".
|
||||
|
||||
|
||||
## Remote access
|
||||
|
||||
It is possible to access a shared library over the internet from a DAAP client
|
||||
like iTunes. You must have remote access to the host machine.
|
||||
|
||||
First log in to the host and forward port 3689 to your local machine. You now
|
||||
need to broadcast the daap service to iTunes on your local machine. On macOS the
|
||||
command is:
|
||||
|
||||
```
|
||||
dns-sd -P iTunesServer _daap._tcp local 3689 localhost.local 127.0.0.1 "ffid=12345"
|
||||
```
|
||||
|
||||
The `ffid` key is required but its value does not matter.
|
||||
|
||||
Your library will now appear as 'iTunesServer' in iTunes.
|
||||
|
||||
You can also access your library remotely using something like Zerotier. See [this
|
||||
guide](https://github.com/owntone/owntone-server/wiki/Accessing-Owntone-remotely-through-iTunes-Music-with-Zerotier)
|
||||
for details.
|
||||
|
||||
|
||||
## Supported formats
|
||||
|
||||
OwnTone should support pretty much all audio formats. It relies on libav
|
||||
(or ffmpeg) to extract metadata and decode the files on the fly when the client
|
||||
doesn't support the format.
|
||||
|
||||
Formats are attributed a code, so any new format will need to be explicitely
|
||||
added. Currently supported:
|
||||
|
||||
- MPEG4: mp4a, mp4v
|
||||
- AAC: alac
|
||||
- MP3 (and friends): mpeg
|
||||
- FLAC: flac
|
||||
- OGG VORBIS: ogg
|
||||
- Musepack: mpc
|
||||
- WMA: wma (WMA Pro), wmal (WMA Lossless), wmav (WMA video)
|
||||
- AIFF: aif
|
||||
- WAV: wav
|
||||
- Monkey's audio: ape
|
||||
|
||||
|
||||
## Playlists and internet radio
|
||||
|
||||
OwnTone supports M3U and PLS playlists. Just drop your playlist somewhere
|
||||
in your library with an .m3u or .pls extension and it will pick it up.
|
||||
|
||||
From the web interface, and some mpd clients, you can also create and modify
|
||||
playlists by saving the current queue. Click the "Save" button. Note that this
|
||||
requires that `allow_modifying_stored_playlists` is enabled in the configuration
|
||||
file, and that the server has write access to `default_playlist_directory`.
|
||||
|
||||
If the playlist contains an http URL it will be added as an internet radio
|
||||
station, and the URL will be probed for Shoutcast (ICY) metadata. If the radio
|
||||
station provides artwork, OwnTone will download it during playback and send
|
||||
it to any remotes or AirPlay devices requesting it.
|
||||
|
||||
Instead of downloading M3U's from your radio stations, you can also make an
|
||||
empty M3U file and insert links in it to the M3U's of your radio stations.
|
||||
|
||||
Radio streams can only be played by OwnTone, so that means they will not be
|
||||
available to play in DAAP clients like iTunes.
|
||||
|
||||
The server can import playlists from iTunes Music Library XML files. By default,
|
||||
metadata from our parsers is preferred over what's in the iTunes DB; use
|
||||
itunes_overrides = true if you prefer iTunes' metadata.
|
||||
|
||||
OwnTone has support for smart playlists. How to create a smart playlist is
|
||||
documented in [Smart playlists](smart-playlists.md).
|
||||
|
||||
If you're not satisfied with internet radio metadata that OwnTone shows,
|
||||
then you can read about tweaking it in
|
||||
[Radio streams](radio-streams.md).
|
||||
|
||||
|
||||
## Artwork
|
||||
|
||||
OwnTone has support for PNG and JPEG artwork which is either:
|
||||
|
||||
- embedded in the media files
|
||||
- placed as separate image files in the library
|
||||
- made available online by the radio station
|
||||
|
||||
For media in your library, OwnTone will try to locate album and artist
|
||||
artwork (group artwork) by the following procedure:
|
||||
|
||||
- if a file {artwork,cover,Folder}.{png,jpg} is found in one of the directories
|
||||
containing files that are part of the group, it is used as the artwork. The
|
||||
first file found is used, ordering is not guaranteed;
|
||||
- failing that, if [directory name].{png,jpg} is found in one of the
|
||||
directories containing files that are part of the group, it is used as the
|
||||
artwork. The first file found is used, ordering is not guaranteed;
|
||||
- failing that, individual files are examined and the first file found
|
||||
with an embedded artwork is used. Here again, ordering is not guaranteed.
|
||||
|
||||
{artwork,cover,Folder} are the default, you can add other base names in the
|
||||
configuration file. Here you can also enable/disable support for individual
|
||||
file artwork (instead of using the same artwork for all tracks in an entire
|
||||
album).
|
||||
|
||||
For playlists in your library, say /foo/bar.m3u, then for any http streams in
|
||||
the list, OwnTone will look for /foo/bar.{jpg,png}.
|
||||
|
||||
You can use symlinks for the artwork files.
|
||||
|
||||
OwnTone caches artwork in a separate cache file. The default path is
|
||||
`/var/cache/owntone/cache.db` and can be configured in the configuration
|
||||
file. The cache.db file can be deleted without losing the library and pairing
|
||||
informations.
|
||||
|
||||
|
||||
## Library
|
||||
|
||||
The library is scanned in bulk mode at startup, but the server will be available
|
||||
even while this scan is in progress. You can follow the progress of the scan in
|
||||
the log file or via the web interface. When the scan is complete you will see
|
||||
the log message: "Bulk library scan completed in X sec".
|
||||
|
||||
The very first scan will take longer than subsequent startup scans, since every
|
||||
file gets analyzed. At the following startups the server looks for changed files
|
||||
and only analyzis those.
|
||||
|
||||
Updates to the library are reflected in real time after the initial scan, so you
|
||||
do not need to manually start rescans. The directories are monitored for changes
|
||||
and rescanned on the fly. Note that if you have your library on a network mount
|
||||
then real time updating may not work. Read below about what to do in that case.
|
||||
|
||||
If you change any of the directory settings in the library section of the
|
||||
configuration file a rescan is required before the new setting will take effect.
|
||||
You can do this by using "Update library" from the web interface.
|
||||
|
||||
Symlinks are supported and dereferenced, but it is best to use them for
|
||||
directories only.
|
||||
|
||||
|
||||
### Pipes (for e.g. multiroom with Shairport-sync)
|
||||
|
||||
Some programs, like for instance Shairport-sync, can be configured to output
|
||||
audio to a named pipe. If this pipe is placed in the library, OwnTone will
|
||||
automatically detect that it is there, and when there is audio being written to
|
||||
it, playback of the audio will be autostarted (and stopped).
|
||||
|
||||
Using this feature, OwnTone can act as an AirPlay multiroom "router": You can
|
||||
have an AirPlay source (e.g. your iPhone) send audio Shairport-sync, which
|
||||
forwards it to OwnTone through the pipe, which then plays it on whatever
|
||||
speakers you have selected (through Remote).
|
||||
|
||||
The format of the audio being written to the pipe must be PCM16.
|
||||
|
||||
You can also start playback of pipes manually. You will find them in remotes
|
||||
listed under "Unknown artist" and "Unknown album". The track title will be the
|
||||
name of the pipe.
|
||||
|
||||
Shairport-sync can write metadata to a pipe, and OwnTone can read this.
|
||||
This requires that the metadata pipe has the same filename as the audio pipe
|
||||
plus a ".metadata" suffix. Say Shairport-sync is configured to write audio to
|
||||
"/foo/bar/pipe", then the metadata pipe should be "/foo/bar/pipe.metadata".
|
||||
|
||||
|
||||
### Libraries on network mounts
|
||||
|
||||
Most network filesharing protocols do not offer notifications when the library
|
||||
is changed. So that means OwnTone cannot update its database in real time.
|
||||
Instead you can schedule a cron job to update the database.
|
||||
|
||||
The first step in doing this is to add two entries to the 'directories'
|
||||
configuration item in owntone.conf:
|
||||
|
||||
```
|
||||
directories = { "/some/local/dir", "/your/network/mount/library" }
|
||||
```
|
||||
|
||||
Now you can make a cron job that runs this command:
|
||||
|
||||
```
|
||||
touch /some/local/dir/trigger.init-rescan
|
||||
```
|
||||
|
||||
When OwnTone detects a file with filename ending .init-rescan it will
|
||||
perform a bulk scan similar to the startup scan.
|
||||
|
||||
Alternatively, you can force a metadata scan of the library even if the
|
||||
files have not changed by creating a filename ending `.meta-rescan`.
|
||||
|
||||
|
||||
### Troubleshooting library issues
|
||||
|
||||
If you place a file with the filename ending .full-rescan in your library,
|
||||
you can trigger a full rescan of your library. This will clear all music and
|
||||
playlists from OwnTone's database and initiate a fresh bulk scan. Pairing
|
||||
and speaker information will be kept. Only use this for troubleshooting, it is
|
||||
not necessary during normal operation.
|
||||
|
||||
|
||||
## Command line
|
||||
|
||||
You can choose between:
|
||||
|
||||
- a [MPD command line client](#mpd-clients) (easiest) like `mpc`
|
||||
- curl with OwnTone's JSON API (see [README_JSON_API.md](https://github.com/owntone/owntone-server/blob/master/README_JSON_API.md))
|
||||
- curl with DAAP/DACP commands (hardest)
|
||||
|
||||
Here is an example of how to use curl with DAAP/DACP. Say you have a playlist
|
||||
with a radio station, and you want to make a script that starts playback of that
|
||||
station:
|
||||
|
||||
1. Run `sqlite3 [your OwnTone db]`. Use `select id,title from files` to get
|
||||
the id of the radio station, and use `select id,title from playlists` to get
|
||||
the id of the playlist.
|
||||
2. Convert the two ids to hex.
|
||||
3. Put the following lines in the script with the relevant ids inserted (also
|
||||
observe that you must use a session-id < 100, and that you must login and
|
||||
logout):
|
||||
|
||||
```
|
||||
curl "http://localhost:3689/login?pairing-guid=0x1&request-session-id=50"
|
||||
curl "http://localhost:3689/ctrl-int/1/playspec?database-spec='dmap.persistentid:0x1'&container-spec='dmap.persistentid:0x[PLAYLIST-ID]'&container-item-spec='dmap.containeritemid:0x[FILE ID]'&session-id=50"
|
||||
curl "http://localhost:3689/logout?session-id=50"
|
||||
```
|
||||
|
||||
|
||||
## Spotify
|
||||
|
||||
OwnTone has built-in support for playback of the tracks in your Spotify library.
|
||||
|
||||
You must have a Spotify premium account. If you normally log into Spotify with
|
||||
your Facebook account you must first go to Spotify's web site where you can get
|
||||
the Spotify username and password that matches your account.
|
||||
|
||||
You must also make sure that your browser can reach OwnTone's web interface via
|
||||
the address [http://owntone.local:3689](http://owntone.local:3689). Try it right
|
||||
now! That is where Spotify's OAuth page will redirect your browser with the
|
||||
token that OwnTone needs, so it must work. The address is announced by the
|
||||
server via mDNS, but if that for some reason doesn't work then configure it via
|
||||
router or .hosts file. You can remove it again after completing the login.
|
||||
|
||||
To authorize OwnTone, open the web interface, locate Settings > Online Services
|
||||
and then click the Authorize button. You will then be sent to Spotify's
|
||||
authorization service, which will send you back to the web interface after
|
||||
you have given the authorization.
|
||||
|
||||
Spotify no longer automatically notifies clients about library updates, so you
|
||||
have to trigger updates manually. You can for instance set up a cron job that
|
||||
runs `/usr/bin/curl http://localhost:3689/api/update`
|
||||
|
||||
To logout and remove Spotify tracks + credentials make a request to
|
||||
[http://[your_server_address_here]:3689/api/spotify-logout](http://[your_server_address_here]:3689/api/spotify-logout).
|
||||
|
||||
Limitations:
|
||||
You will not be able to do any playlist management through OwnTone - use
|
||||
a Spotify client for that. You also can only listen to your music by letting
|
||||
OwnTone do the playback - so that means you can't stream to DAAP clients (e.g.
|
||||
iTunes) and RSP clients.
|
||||
|
||||
### Via librespot/spocon
|
||||
|
||||
You can also use OwnTone with one of the various incarnations of
|
||||
[librespot](https://github.com/librespot-org/librespot). This adds librespot as
|
||||
a selectable metaspeaker in Spotify's client, and when you start playback,
|
||||
librespot can be configured to start writing audio to a pipe that you have added
|
||||
to your library. This will be detected by OwnTone that then starts playback.
|
||||
You can also have a pipe for metadata and playback events, e.g. volume changes.
|
||||
|
||||
The easiest way of accomplishing this may be with [Spocon](https://github.com/spocon/spocon),
|
||||
since it requires minimal configuration. After installing, create two pipes
|
||||
(with mkfifo) and set the configuration in the player section:
|
||||
|
||||
```
|
||||
# Audio output device (MIXER, PIPE, STDOUT)
|
||||
output = "PIPE"
|
||||
# Output raw (signed) PCM to this file (`player.output` must be PIPE)
|
||||
pipe = "/srv/music/spotify"
|
||||
# Output metadata in Shairport Sync format (https://github.com/mikebrady/shairport-sync-metadata-reader)
|
||||
metadataPipe = "/srv/music/spotify.metadata"
|
||||
```
|
||||
|
||||
### Via libspotify
|
||||
|
||||
This method is being deprecated, but is still available if the server was built
|
||||
with it, libspotify is installed and `use_libspotify` is enabled in the config
|
||||
file. Please consult [previous README versions](#references) for details on
|
||||
using libspotify.
|
||||
|
||||
|
||||
## LastFM
|
||||
|
||||
You can have OwnTone scrobble the music you listen to. To set up scrobbling
|
||||
go to the web interface and authorize OwnTone with your LastFM credentials.
|
||||
|
||||
OwnTone will not store your LastFM username/password, only the session key.
|
||||
The session key does not expire.
|
||||
|
||||
|
||||
## MPD clients
|
||||
|
||||
You can - to some extent - use clients for MPD to control OwnTone.
|
||||
|
||||
By default OwnTone listens on port 6600 for MPD clients. You can change
|
||||
this in the configuration file.
|
||||
|
||||
Currently only a subset of the commands offered by MPD (see [MPD protocol documentation](http://www.musicpd.org/doc/protocol/))
|
||||
are supported.
|
||||
|
||||
Due to some differences between OwnTone and MPD not all commands will act the
|
||||
same way they would running MPD:
|
||||
|
||||
- crossfade, mixrampdb, mixrampdelay and replaygain will have no effect
|
||||
- single, repeat: unlike MPD, OwnTone does not support setting single and repeat separately
|
||||
on/off, instead repeat off, repeat all and repeat single are supported. Thus setting single on
|
||||
will result in repeat single, repeat on results in repeat all.
|
||||
|
||||
The following table shows what is working for a selection of MPD clients:
|
||||
|
||||
| Client | Type | Status |
|
||||
| --------------------------------------------- | ------ | --------------- |
|
||||
| [mpc](http://www.musicpd.org/clients/mpc/) | CLI | Working commands: mpc, add, crop, current, del (ranges are not yet supported), play, next, prev (behaves like cdprev), pause, toggle, cdprev, seek, clear, outputs, enable, disable, playlist, ls, load, volume, repeat, random, single, search, find, list, update (initiates an init-rescan, the path argument is not supported) |
|
||||
| [ympd](http://www.ympd.org/) | Web | Everything except "add stream" should work |
|
||||
|
||||
## Running Multiple Instances
|
||||
|
||||
To run multiple instances of owntone on a server, you should copy
|
||||
`/etc/owntone.conf` to `/etc/owntone-zone.conf` (for each `zone`) and
|
||||
modify the following to be unique across all instances:
|
||||
|
||||
* the three port settings (`general` -> `websocket_port`,
|
||||
`library` -> `port`, and `mpd` -> `port`)
|
||||
|
||||
* the database paths (`general` -> `db_path`, `db_backup_path`, and `db_cache_path`)
|
||||
|
||||
* the service name (`library` -> `name`).
|
||||
|
||||
* you probably also want to disable local output (set `audio` -> `type =
|
||||
"disabled"`).
|
||||
|
||||
Then run `owntone -c /etc/owntone-zone.conf` to run owntone with the new
|
||||
zone configuration.
|
||||
|
||||
Owntone has a `systemd` template which lets you run this automatically
|
||||
on systems that use systemd. You can start or enable the service for
|
||||
a `zone` by `sudo systemctl start owntone@zone` and check that it is
|
||||
running with `sudo systemctl status owntone@zone`. Use `sudo
|
||||
systemctl enable ownton@zone` to get the service to start on reboot.
|
||||
|
||||
## References
|
||||
|
||||
The source for this version of OwnTone can be found here:
|
||||
|
||||
- [https://github.com/owntone/owntone-server.git](https://github.com/owntone/owntone-server.git)
|
||||
|
||||
README's for current and previous versions of OwnTone:
|
||||
|
||||
- [OwnTone version 28.3](https://github.com/owntone/owntone-server/blob/28.3/README.md)
|
||||
|
||||
- [OwnTone version 28.2](https://github.com/owntone/owntone-server/blob/28.2/README.md)
|
||||
|
||||
- [OwnTone version 28.1](https://github.com/owntone/owntone-server/blob/28.1/README.md)
|
||||
|
||||
README from when OwnTone was forked-daapd:
|
||||
|
||||
- [forked-daapd version 27.4](https://github.com/owntone/owntone-server/blob/27.4/README.md)
|
||||
14
docs/getting-started.md
Normal file
14
docs/getting-started.md
Normal file
@ -0,0 +1,14 @@
|
||||
# Getting started
|
||||
|
||||
After installation (see [Installation](installation.md)) do the following:
|
||||
|
||||
1. Edit the configuration file (usually `/etc/owntone.conf`) to suit your
|
||||
needs
|
||||
2. Start or restart the server (usually `/etc/init.d/owntone restart`)
|
||||
3. Go to the web interface [http://owntone.local:3689](http://owntone.local:3689),
|
||||
or, if that won't work, to [http://[your_server_address_here]:3689](http://[your_server_address_here]:3689)
|
||||
4. Wait for the library scan to complete
|
||||
5. If you will be using a remote, e.g. Apple Remote: Start the remote, go to
|
||||
Settings, Add Library
|
||||
6. Enter the pair code in the web interface (update the page with F5 if it does
|
||||
not automatically pick up the pairing request)
|
||||
@ -1,3 +1,9 @@
|
||||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
# OwnTone
|
||||
|
||||
**OwnTone** is an open source (audio) media server for GNU/Linux, FreeBSD
|
||||
@ -41,11 +47,11 @@ mt-daapd (Firefly Media Server). It is written in C with a web interface written
|
||||
|
||||
---
|
||||
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
{: class="zoom" }
|
||||
|
||||
_(You can find more screenshots from OwnTone's web interface [here](web-interface.md))_
|
||||
_(You can find more screenshots from OwnTone's web interface [here](clients/web-interface.md))_
|
||||
{: class="text-center" }
|
||||
|
||||
---
|
||||
@ -69,4 +75,16 @@ please see the documentation on [Building from Source](installation.md).
|
||||
|
||||
The source for this version of OwnTone can be found here:
|
||||
|
||||
[https://github.com/owntone/owntone-server.git](https://github.com/owntone/owntone-server.git)
|
||||
- [https://github.com/owntone/owntone-server.git](https://github.com/owntone/owntone-server.git)
|
||||
|
||||
README's for current and previous versions of OwnTone:
|
||||
|
||||
- [OwnTone version 28.3](https://github.com/owntone/owntone-server/blob/28.3/README.md)
|
||||
|
||||
- [OwnTone version 28.2](https://github.com/owntone/owntone-server/blob/28.2/README.md)
|
||||
|
||||
- [OwnTone version 28.1](https://github.com/owntone/owntone-server/blob/28.1/README.md)
|
||||
|
||||
README from when OwnTone was forked-daapd:
|
||||
|
||||
- [forked-daapd version 27.4](https://github.com/owntone/owntone-server/blob/27.4/README.md)
|
||||
|
||||
@ -73,7 +73,7 @@ settings that normally require modification.
|
||||
Start the server with `sudo systemctl start owntone` and check that it is
|
||||
running with `sudo systemctl status owntone`.
|
||||
|
||||
See the [Documentation](documentation.md) for usage information.
|
||||
See the [Documentation](getting-started.md) for usage information.
|
||||
|
||||
## Quick version for Fedora
|
||||
|
||||
@ -118,7 +118,7 @@ settings that normally require modification.
|
||||
Start the server with `sudo systemctl start owntone` and check that it is
|
||||
running with `sudo systemctl status owntone`.
|
||||
|
||||
See the [Documentation](documentation.md) for usage information.
|
||||
See the [Documentation](getting-started.md) for usage information.
|
||||
|
||||
## Quick version for FreeBSD
|
||||
|
||||
@ -313,7 +313,7 @@ The source for the player web interface is located under the `web-src` folder an
|
||||
requires nodejs >= 6.0 to be built. In the `web-src` folder run `npm install` to
|
||||
install all dependencies for the player web interface. After that run `npm run build`.
|
||||
This will build the web interface and update the `htdocs` folder.
|
||||
(See [Web interface](web-interface.md) for more
|
||||
(See [Web interface](clients/web-interface.md) for more
|
||||
informations)
|
||||
|
||||
Building with libwebsockets is required if you want the web interface. It will be enabled
|
||||
|
||||
8
docs/integrations/lastfm.md
Normal file
8
docs/integrations/lastfm.md
Normal file
@ -0,0 +1,8 @@
|
||||
# LastFM
|
||||
|
||||
You can have OwnTone scrobble the music you listen to. To set up scrobbling
|
||||
go to the web interface and authorize OwnTone with your LastFM credentials.
|
||||
|
||||
OwnTone will not store your LastFM username/password, only the session key.
|
||||
The session key does not expire.
|
||||
|
||||
61
docs/integrations/spotify.md
Normal file
61
docs/integrations/spotify.md
Normal file
@ -0,0 +1,61 @@
|
||||
# Spotify
|
||||
|
||||
OwnTone has built-in support for playback of the tracks in your Spotify library.
|
||||
|
||||
You must have a Spotify premium account. If you normally log into Spotify with
|
||||
your Facebook account you must first go to Spotify's web site where you can get
|
||||
the Spotify username and password that matches your account.
|
||||
|
||||
You must also make sure that your browser can reach OwnTone's web interface via
|
||||
the address [http://owntone.local:3689](http://owntone.local:3689). Try it right
|
||||
now! That is where Spotify's OAuth page will redirect your browser with the
|
||||
token that OwnTone needs, so it must work. The address is announced by the
|
||||
server via mDNS, but if that for some reason doesn't work then configure it via
|
||||
router or .hosts file. You can remove it again after completing the login.
|
||||
|
||||
To authorize OwnTone, open the web interface, locate Settings > Online Services
|
||||
and then click the Authorize button. You will then be sent to Spotify's
|
||||
authorization service, which will send you back to the web interface after
|
||||
you have given the authorization.
|
||||
|
||||
Spotify no longer automatically notifies clients about library updates, so you
|
||||
have to trigger updates manually. You can for instance set up a cron job that
|
||||
runs `/usr/bin/curl http://localhost:3689/api/update`
|
||||
|
||||
To logout and remove Spotify tracks + credentials make a request to
|
||||
[http://[your_server_address_here]:3689/api/spotify-logout](http://[your_server_address_here]:3689/api/spotify-logout).
|
||||
|
||||
Limitations:
|
||||
You will not be able to do any playlist management through OwnTone - use
|
||||
a Spotify client for that. You also can only listen to your music by letting
|
||||
OwnTone do the playback - so that means you can't stream to DAAP clients (e.g.
|
||||
iTunes) and RSP clients.
|
||||
|
||||
## Via librespot/spocon
|
||||
|
||||
You can also use OwnTone with one of the various incarnations of
|
||||
[librespot](https://github.com/librespot-org/librespot). This adds librespot as
|
||||
a selectable metaspeaker in Spotify's client, and when you start playback,
|
||||
librespot can be configured to start writing audio to a pipe that you have added
|
||||
to your library. This will be detected by OwnTone that then starts playback.
|
||||
You can also have a pipe for metadata and playback events, e.g. volume changes.
|
||||
|
||||
The easiest way of accomplishing this may be with [Spocon](https://github.com/spocon/spocon),
|
||||
since it requires minimal configuration. After installing, create two pipes
|
||||
(with mkfifo) and set the configuration in the player section:
|
||||
|
||||
```
|
||||
# Audio output device (MIXER, PIPE, STDOUT)
|
||||
output = "PIPE"
|
||||
# Output raw (signed) PCM to this file (`player.output` must be PIPE)
|
||||
pipe = "/srv/music/spotify"
|
||||
# Output metadata in Shairport Sync format (https://github.com/mikebrady/shairport-sync-metadata-reader)
|
||||
metadataPipe = "/srv/music/spotify.metadata"
|
||||
```
|
||||
|
||||
## Via libspotify
|
||||
|
||||
This method is being deprecated, but is still available if the server was built
|
||||
with it, libspotify is installed and `use_libspotify` is enabled in the config
|
||||
file. Please consult [previous README versions](#references) for details on
|
||||
using libspotify.
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
hide:
|
||||
- navigation
|
||||
---
|
||||
|
||||
# OwnTone API Endpoint Reference
|
||||
|
||||
Available API endpoints:
|
||||
|
||||
100
docs/library.md
Normal file
100
docs/library.md
Normal file
@ -0,0 +1,100 @@
|
||||
# Library
|
||||
|
||||
The library is scanned in bulk mode at startup, but the server will be available
|
||||
even while this scan is in progress. You can follow the progress of the scan in
|
||||
the log file or via the web interface. When the scan is complete you will see
|
||||
the log message: "Bulk library scan completed in X sec".
|
||||
|
||||
The very first scan will take longer than subsequent startup scans, since every
|
||||
file gets analyzed. At the following startups the server looks for changed files
|
||||
and only analyzis those.
|
||||
|
||||
Updates to the library are reflected in real time after the initial scan, so you
|
||||
do not need to manually start rescans. The directories are monitored for changes
|
||||
and rescanned on the fly. Note that if you have your library on a network mount
|
||||
then real time updating may not work. Read below about what to do in that case.
|
||||
|
||||
If you change any of the directory settings in the library section of the
|
||||
configuration file a rescan is required before the new setting will take effect.
|
||||
You can do this by using "Update library" from the web interface.
|
||||
|
||||
Symlinks are supported and dereferenced, but it is best to use them for
|
||||
directories only.
|
||||
|
||||
|
||||
## Pipes (for e.g. multiroom with Shairport-sync)
|
||||
|
||||
Some programs, like for instance Shairport-sync, can be configured to output
|
||||
audio to a named pipe. If this pipe is placed in the library, OwnTone will
|
||||
automatically detect that it is there, and when there is audio being written to
|
||||
it, playback of the audio will be autostarted (and stopped).
|
||||
|
||||
Using this feature, OwnTone can act as an AirPlay multiroom "router": You can
|
||||
have an AirPlay source (e.g. your iPhone) send audio Shairport-sync, which
|
||||
forwards it to OwnTone through the pipe, which then plays it on whatever
|
||||
speakers you have selected (through Remote).
|
||||
|
||||
The format of the audio being written to the pipe must be PCM16.
|
||||
|
||||
You can also start playback of pipes manually. You will find them in remotes
|
||||
listed under "Unknown artist" and "Unknown album". The track title will be the
|
||||
name of the pipe.
|
||||
|
||||
Shairport-sync can write metadata to a pipe, and OwnTone can read this.
|
||||
This requires that the metadata pipe has the same filename as the audio pipe
|
||||
plus a ".metadata" suffix. Say Shairport-sync is configured to write audio to
|
||||
"/foo/bar/pipe", then the metadata pipe should be "/foo/bar/pipe.metadata".
|
||||
|
||||
|
||||
## Libraries on network mounts
|
||||
|
||||
Most network filesharing protocols do not offer notifications when the library
|
||||
is changed. So that means OwnTone cannot update its database in real time.
|
||||
Instead you can schedule a cron job to update the database.
|
||||
|
||||
The first step in doing this is to add two entries to the 'directories'
|
||||
configuration item in owntone.conf:
|
||||
|
||||
```
|
||||
directories = { "/some/local/dir", "/your/network/mount/library" }
|
||||
```
|
||||
|
||||
Now you can make a cron job that runs this command:
|
||||
|
||||
```
|
||||
touch /some/local/dir/trigger.init-rescan
|
||||
```
|
||||
|
||||
When OwnTone detects a file with filename ending .init-rescan it will
|
||||
perform a bulk scan similar to the startup scan.
|
||||
|
||||
Alternatively, you can force a metadata scan of the library even if the
|
||||
files have not changed by creating a filename ending `.meta-rescan`.
|
||||
|
||||
## Supported formats
|
||||
|
||||
OwnTone should support pretty much all audio formats. It relies on libav
|
||||
(or ffmpeg) to extract metadata and decode the files on the fly when the client
|
||||
doesn't support the format.
|
||||
|
||||
Formats are attributed a code, so any new format will need to be explicitely
|
||||
added. Currently supported:
|
||||
|
||||
- MPEG4: mp4a, mp4v
|
||||
- AAC: alac
|
||||
- MP3 (and friends): mpeg
|
||||
- FLAC: flac
|
||||
- OGG VORBIS: ogg
|
||||
- Musepack: mpc
|
||||
- WMA: wma (WMA Pro), wmal (WMA Lossless), wmav (WMA video)
|
||||
- AIFF: aif
|
||||
- WAV: wav
|
||||
- Monkey's audio: ape
|
||||
|
||||
## Troubleshooting library issues
|
||||
|
||||
If you place a file with the filename ending .full-rescan in your library,
|
||||
you can trigger a full rescan of your library. This will clear all music and
|
||||
playlists from OwnTone's database and initiate a fresh bulk scan. Pairing
|
||||
and speaker information will be kept. Only use this for troubleshooting, it is
|
||||
not necessary during normal operation.
|
||||
20
docs/outputs/airplay.md
Normal file
20
docs/outputs/airplay.md
Normal file
@ -0,0 +1,20 @@
|
||||
# AirPlay devices/speakers
|
||||
|
||||
OwnTone will discover the AirPlay devices available on your network. For
|
||||
devices that are password-protected, the device's AirPlay name and password
|
||||
must be given in the configuration file. See the sample configuration file
|
||||
for the syntax.
|
||||
|
||||
If your Apple TV requires device verification (always required by Apple TV4 with
|
||||
tvOS 10.2) then you can do that through Settings > Remotes & Outputs in the web
|
||||
interface: Select the device and then enter the PIN that the Apple TV displays.
|
||||
|
||||
If your speaker is silent when you start playback, and there is no obvious error
|
||||
message in the log, you can try disabling ipv6 in the config. Some speakers
|
||||
announce that they support ipv6, but in fact don't (at least not with forked-
|
||||
daapd).
|
||||
|
||||
If the speaker becomes unselected when you start playback, and you in the log
|
||||
see "ANNOUNCE request failed in session startup: 400 Bad Request", then try
|
||||
the Apple Home app > Allow Speakers & TV Access > Anyone On the Same Network
|
||||
(or Everyone).
|
||||
4
docs/outputs/chromecast.md
Normal file
4
docs/outputs/chromecast.md
Normal file
@ -0,0 +1,4 @@
|
||||
# Chromecast
|
||||
|
||||
OwnTone will discover Chromecast devices available on your network, and you
|
||||
can then select the device as a speaker. There is no configuration required.
|
||||
25
docs/outputs/local-audio.md
Normal file
25
docs/outputs/local-audio.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Local audio
|
||||
|
||||
## Local audio through ALSA
|
||||
|
||||
In the config file, you can select ALSA for local audio. This is the default.
|
||||
|
||||
When using ALSA, the server will try to syncronize playback with AirPlay. You
|
||||
can adjust the syncronization in the config file.
|
||||
|
||||
For most setups the default values in the config file should work. If they
|
||||
don't, there is help [here](../advanced/outputs-alsa.md)
|
||||
|
||||
|
||||
## Local audio, Bluetooth and more through Pulseaudio
|
||||
|
||||
In the config file, you can select Pulseaudio for local audio. In addition to
|
||||
local audio, Pulseaudio also supports an array of other targets, e.g. Bluetooth
|
||||
or DLNA. However, Pulseaudio does require some setup, so here is a separate page
|
||||
with some help on that: [Pulse audio](../advanced/outputs-pulse.md)
|
||||
|
||||
Note that if you select Pulseaudio the "card" setting in the config file has
|
||||
no effect. Instead all soundcards detected by Pulseaudio will be listed as
|
||||
speakers by OwnTone.
|
||||
|
||||
You can adjust the latency of Pulseaudio playback in the config file.
|
||||
19
docs/outputs/streaming.md
Normal file
19
docs/outputs/streaming.md
Normal file
@ -0,0 +1,19 @@
|
||||
# MP3 network streaming (streaming to iOS)
|
||||
|
||||
You can listen to audio being played by OwnTone by opening this network
|
||||
stream address in pretty much any music player:
|
||||
|
||||
http://[your hostname/ip address]:3689/stream.mp3
|
||||
|
||||
This is currently the only way of listening to your audio on iOS devices, since
|
||||
Apple does not allow AirPlay receiver apps, and because Apple Home Sharing
|
||||
cannot be supported by OwnTone. So what you can do instead is install a
|
||||
music player app like VLC, connect to the stream and control playback with
|
||||
Remote.
|
||||
|
||||
In the speaker selection list, clicking on the icon should start the stream
|
||||
playing in the background on browsers that support that.
|
||||
|
||||
Note that MP3 encoding must be supported by ffmpeg/libav for this to work. If
|
||||
it is not available you will see a message in the log file. In Debian/Ubuntu you
|
||||
get MP3 encoding support by installing the package "libavcodec-extra".
|
||||
31
docs/playlists.md
Normal file
31
docs/playlists.md
Normal file
@ -0,0 +1,31 @@
|
||||
# Playlists and internet radio
|
||||
|
||||
OwnTone supports M3U and PLS playlists. Just drop your playlist somewhere
|
||||
in your library with an .m3u or .pls extension and it will pick it up.
|
||||
|
||||
From the web interface, and some mpd clients, you can also create and modify
|
||||
playlists by saving the current queue. Click the "Save" button. Note that this
|
||||
requires that `allow_modifying_stored_playlists` is enabled in the configuration
|
||||
file, and that the server has write access to `default_playlist_directory`.
|
||||
|
||||
If the playlist contains an http URL it will be added as an internet radio
|
||||
station, and the URL will be probed for Shoutcast (ICY) metadata. If the radio
|
||||
station provides artwork, OwnTone will download it during playback and send
|
||||
it to any remotes or AirPlay devices requesting it.
|
||||
|
||||
Instead of downloading M3U's from your radio stations, you can also make an
|
||||
empty M3U file and insert links in it to the M3U's of your radio stations.
|
||||
|
||||
Radio streams can only be played by OwnTone, so that means they will not be
|
||||
available to play in DAAP clients like iTunes.
|
||||
|
||||
The server can import playlists from iTunes Music Library XML files. By default,
|
||||
metadata from our parsers is preferred over what's in the iTunes DB; use
|
||||
itunes_overrides = true if you prefer iTunes' metadata.
|
||||
|
||||
OwnTone has support for smart playlists. How to create a smart playlist is
|
||||
documented in [Smart playlists](smart-playlists.md).
|
||||
|
||||
If you're not satisfied with internet radio metadata that OwnTone shows,
|
||||
then you can read about tweaking it in
|
||||
[Radio streams](advanced/radio-streams.md).
|
||||
@ -1,2 +0,0 @@
|
||||
#!/bin/sh
|
||||
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
|
||||
18
mkdocs.sh
Executable file
18
mkdocs.sh
Executable file
@ -0,0 +1,18 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Run mkdocs commands
|
||||
#
|
||||
# No local installation of mkdocs and the required plugins is required.
|
||||
# Instead this script uses the offical docker image for "Material for MkDocs"
|
||||
#
|
||||
# https://squidfunk.github.io/mkdocs-material/getting-started/#with-docker
|
||||
#
|
||||
# Without arguments the "serve" command is executed (starts the local development
|
||||
# server).
|
||||
#
|
||||
# Usage examples:
|
||||
#
|
||||
# - Build documentation: ./mkdocs.sh build
|
||||
# - Show command help: ./mkdocs.sh --help
|
||||
|
||||
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material $@
|
||||
48
mkdocs.yml
48
mkdocs.yml
@ -14,6 +14,14 @@
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
|
||||
# OwnTone configuration file for MkDocs with the theme "Material for MkDocs"
|
||||
#
|
||||
# Documentation for the different conig options:
|
||||
# - https://squidfunk.github.io/mkdocs-material/
|
||||
# - https://www.mkdocs.org/
|
||||
|
||||
|
||||
# Project information
|
||||
site_name: OwnTone
|
||||
site_url: https://owntone.github.io/owntone-server/
|
||||
@ -33,8 +41,10 @@ theme:
|
||||
name: 'material'
|
||||
language: en
|
||||
features:
|
||||
# - navigation.tabs
|
||||
- navigation.sections
|
||||
- navigation.tabs
|
||||
# - navigation.sections
|
||||
# - navigation.indexes
|
||||
- navigation.top
|
||||
palette:
|
||||
- scheme: default
|
||||
primary: white
|
||||
@ -116,11 +126,31 @@ markdown_extensions:
|
||||
# Page tree
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Documentation: documentation.md
|
||||
- Installation: installation.md
|
||||
- Smart playlists: smart-playlists.md
|
||||
- Documentation:
|
||||
- Getting started: getting-started.md
|
||||
- Installation: installation.md
|
||||
- Library: library.md
|
||||
- Artwork: artwork.md
|
||||
- Playlists & radio: playlists.md
|
||||
- Smart playlists: smart-playlists.md
|
||||
- Clients:
|
||||
- Supported clients: clients/supported-clients.md
|
||||
- Remote: clients/remote.md
|
||||
- Web interface: clients/web-interface.md
|
||||
- MPD clients: clients/mpd.md
|
||||
- CLI: clients/cli.md
|
||||
- Outputs:
|
||||
- Local audio: outputs/local-audio.md
|
||||
- Airplay: outputs/airplay.md
|
||||
- Chromecast: outputs/chromecast.md
|
||||
- Streaming: outputs/streaming.md
|
||||
- Services integration:
|
||||
- Spotify: integrations/spotify.md
|
||||
- LastFM: integrations/lastfm.md
|
||||
- Advanced setups:
|
||||
- Alsa: advanced/outputs-alsa.md
|
||||
- Pulse audio: advanced/outputs-pulse.md
|
||||
- Radio streams: advanced/radio-streams.md
|
||||
- Remote access: advanced/remote-access.md
|
||||
- Multiple instances: advanced/multiple-instances.md
|
||||
- JSON API: json-api.md
|
||||
- Web interface: web-interface.md
|
||||
- Alsa: outputs-alsa.md
|
||||
- Pulse audio: outputs-pulse.md
|
||||
- Radio streams: radio-streams.md
|
||||
|
||||
Loading…
Reference in New Issue
Block a user