Difference between revisions of "Shairport Sync"

From ArchWiki
Jump to: navigation, search
m (Installation)
m (add ja link)
 
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
[[Category:Streaming]]
 
[[Category:Streaming]]
Shairport is a utility for emulating the functionality of an AirPort Express on a linux box. However, since it has been created by reverse-engineering Apple's key used in its AirPort Express, be advised that the functionality may be removed at Apple's discretion.
+
[[ja:Shairport Sync]]
 +
Shairport Sync is an AirPlay audio player — it plays audio streamed from iTunes, iOS devices and third-party AirPlay sources such as ForkedDaapd and others. Audio played by a Shairport Sync-powered device stays synchronised with the source and hence with similar devices playing the same source. In this way, synchronised multi-room audio is possible without difficulty. (Hence the name Shairport Sync, BTW.)
 +
 
 +
Shairport Sync does not support AirPlay video or photo streaming.
 +
 
 +
Shairport Sync is a fork of the original Shairport which was based on reverse-engineering Apple's key used in its AirPort Express. Be advised that this functionality may be removed at Apple's discretion.  
  
 
==Installation==
 
==Installation==
Shairport is available in the AUR through three different packages:
 
* {{AUR|shairport}}
 
* {{AUR|shairport-git}}
 
* {{AUR|shairport-git-sysdcompat}}
 
  
The third package provides ready made systemd scripts and hence comes recommended. It is recommended to install the package {{pkg|perl-io-socket-inet6}} when installing either of the first two packages. This prevents the daemon from giving warnings about the unavailability of inet6 and compatibility with iTunes. However, the third package is based on [https://github.com/abrasive/shairport/tree/1.0-dev abrasive/shairport#1.0-dev], which no longer uses Perl, and therefore does NOT require perl-io-socket-inet6.
+
[[Install]] the {{Pkg|shairport-sync}} package.
  
 
==Configuration==
 
==Configuration==
The configuration is managed by the perl script /usr/bin/shairport.pl. For novice users, the defaults should be left as is, unless they wish to set a password for the AirPlay server. In this case, they should change line 56 from {{ic|<nowiki>my $password = '';</nowiki>}} to {{ic|<nowiki>my $password = '<yourpassword>';</nowiki>}} where <yourpassword> is to be replaced by the password of your choice.
 
 
If you have not used the shairport-git-sysdcompat package, then you will need to create the systemd service file on your own. The one used by the sysdcompat package is:
 
 
{{bc|<nowiki>[Unit]
 
Description=Shairport Airtunes emulator
 
Requires=avahi-daemon.service
 
 
[Service]
 
Type=forking
 
PIDFile=/var/run/shairport.pid
 
ExecStart=/usr/bin/shairport.pl -d --writepid=/var/run/shairport.pid -a %i
 
 
[Install]
 
WantedBy=multi-user.target</nowiki>}}
 
 
If you are manually creating the file, remember to run {{ic|systemctl daemon-reload}} after writing the file. For starting the service, simply issue the command:
 
 
# systemctl start shairport@<nameofserver>.service
 
  
where <nameofserver> can be any name of your choice. While it has not been tested, it would be good if the name avoided any special characters. For automatically starting the service at launch, issue the command:
+
The configuration file can be found at {{ic|/etc/shairport-sync.conf}}. It contains useful comments and configuration hints. More documentation is available in the [https://github.com/mikebrady/shairport-sync/blob/master/README.md#configuring-shairport-sync README] file.
  
# systemctl enable shairport@<nameofserver>.service
+
==Starting==
  
The result should be an AirPort station by the name <nameofserver> which should be able to accept output from any Apple product.
+
[[Start]]/[[enable]] {{ic|shairport-sync.service}} using systemd.

Latest revision as of 09:22, 4 February 2016

Shairport Sync is an AirPlay audio player — it plays audio streamed from iTunes, iOS devices and third-party AirPlay sources such as ForkedDaapd and others. Audio played by a Shairport Sync-powered device stays synchronised with the source and hence with similar devices playing the same source. In this way, synchronised multi-room audio is possible without difficulty. (Hence the name Shairport Sync, BTW.)

Shairport Sync does not support AirPlay video or photo streaming.

Shairport Sync is a fork of the original Shairport which was based on reverse-engineering Apple's key used in its AirPort Express. Be advised that this functionality may be removed at Apple's discretion.

Installation

Install the shairport-sync package.

Configuration

The configuration file can be found at /etc/shairport-sync.conf. It contains useful comments and configuration hints. More documentation is available in the README file.

Starting

Start/enable shairport-sync.service using systemd.