3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-08-06 10:09:33 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'axelsimon-patch-1' into develop

Browse source
This commit is contained in:
badaix 2020-02-24 12:05:02 +01:00
commit a4cc313770
1 changed files with 43 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -34,57 +34,74 @@ For more information on the binary protocol, please see the [documentation](doc/
Installation Installation
------------ ------------
You can either build and install snapcast from source, or on Debian systems install a prebuilt .deb package You can either install Snapcast from a prebuilt package (recommended for new users), or build and install snapcast from source.
### Installation from source ### Install Linux packages (recommended for beginners)
Please follow this [guide](doc/build.md) to build Snapcast for Snapcast packages are available for several Linux distributions.
* [Linux](doc/build.md#linux-native)
* [FreeBSD](doc/build.md#freebsd-native)
* [macOS](doc/build.md#macos-native)
* [Android](doc/build.md#android-cross-compile)
* [OpenWrt](doc/build.md#openwrtlede-cross-compile)
* [Buildroot](doc/build.md#buildroot-cross-compile)
* [Raspberry Pi](doc/build.md#raspberry-pi-cross-compile)
### Install Linux packages
#### Debian #### Debian
Download the package for your CPU architecture from the [latest release page](https://github.com/badaix/snapcast/releases/latest), e.g. for Raspberry Pi `snapclient_0.x.x_armhf.deb` For Debian (and Debian-based systems, such as Ubuntu, Linux Mint, ElementaryOS) download the package for your CPU architecture from the [latest release page](https://github.com/badaix/snapcast/releases/latest).
e.g. for Raspberry Pi `snapclient_0.x.x_armhf.deb`, for laptops `snapclient_0.x.x_amd64.deb`
Install the package: Install the package:
$ sudo dpkg -i snapclient_0.x.x_armhf.deb $ sudo dpkg -i snapclient_0.x.x_armhf.deb
or
$ sudo dpkg -i snapclient_0.x.x_amd64.deb
Install missing dependencies: Install missing dependencies:
$ sudo apt-get -f install $ sudo apt-get -f install
#### OpenWrt #### OpenWrt
On OpenWrt do:
$ opkg install snapclient_0.x.x_ar71xx.ipk $ opkg install snapclient_0.x.x_ar71xx.ipk
#### Alpine Linux #### Alpine Linux
On Alpine Linux do:
$ apk add snapcast $ apk add snapcast
Or for just the client: Or, for just the client:
$ apk add snapcast-client $ apk add snapcast-client
Or for just the server: Or, for just the server:
$ apk add snapcast-server $ apk add snapcast-server
#### Gentoo Linux: #### Gentoo Linux
On Gentoo Linux do:
$ emerge --ask media-sound/snapcast $ emerge --ask media-sound/snapcast
#### Arch Linux #### Archlinux
Snapcast is available through the AUR. To install, use your favorite AUR helper, or do: On Archlinux, Snapcast is available through the AUR. To install, use your favorite AUR helper, or do:
$ git clone https://aur.archlinux.org/snapcast $ git clone https://aur.archlinux.org/snapcast
$ cd snapcast $ cd snapcast
$ makepkg -si $ makepkg -si
### Installation from source
Please follow this [guide](doc/build.md) to build Snapcast for
* [Linux](doc/build.md#linux-native)
* [FreeBSD](doc/build.md#freebsd-native)
* [macOS](doc/build.md#macos-native)
* [Android](doc/build.md#android-cross-compile)
* [OpenWrt](doc/build.md#openwrtlede-cross-compile)
* [Buildroot](doc/build.md#buildroot-cross-compile)
* [Raspberry Pi](doc/build.md#raspberry-pi-cross-compile)
#### Void Linux #### Void Linux
To install the client: To install the client:
@ -96,7 +113,13 @@ To install the server:
SnapOS SnapOS
------ ------
For the brave of you, there is a guide with buildfiles available to build [SnapOS](https://github.com/badaix/snapos), a small and fast-booting OS to run Snapcast, coming in two flavors: [Buildroot](https://github.com/badaix/snapos/blob/master/buildroot-external/README.md) based, or [OpenWrt](https://github.com/badaix/snapos/tree/master/openwrt) based. Please note that there are no pre-built firmware packages available. The bravest among you may be interested in [SnapOS](https://github.com/badaix/snapos), a small and fast-booting "just enough" OS to run Snapcast as an appliance.
There is a guide (with the necessary buildfiles) available to build SnapOS, which comes in two flavors:
- [Buildroot](https://github.com/badaix/snapos/blob/master/buildroot-external/README.md) based, or
- [OpenWrt](https://github.com/badaix/snapos/tree/master/openwrt) based.
Please note that there are no pre-built firmware packages available.
Configuration Configuration
------------- -------------
@ -154,9 +177,9 @@ There is also an unofficial WebApp from @atoomic [atoomic/snapcast-volume-ui](ht
This app lists all clients connected to a server and allows you to control individually the volume of each client. This app lists all clients connected to a server and allows you to control individually the volume of each client.
Once installed, you can use any mobile device, laptop, desktop, or browser. Once installed, you can use any mobile device, laptop, desktop, or browser.
There is also an [unofficial FHEM module](https://forum.fhem.de/index.php/topic,62389.0.html) from @unimatrix27 which integrates a snapcast controller into the [FHEM](https://fhem.de/fhem.html) home automation system. There is also an [unofficial FHEM module](https://forum.fhem.de/index.php/topic,62389.0.html) from @unimatrix27 which integrates a Snapcast controller into the [FHEM](https://fhem.de/fhem.html) home automation system.
There is a [snapcast component for Home Assistant](https://home-assistant.io/components/media_player.snapcast/) which integrates a snapcast controller in to the [Home Assistant](https://home-assistant.io/) home automation system. There is a [snapcast component for Home Assistant](https://home-assistant.io/components/media_player.snapcast/) which integrates a Snapcast controller in to the [Home Assistant](https://home-assistant.io/) home automation system.
For a web interface in Python, see [snapcastr](https://github.com/xkonni/snapcastr), based on [python-snapcast](https://github.com/happyleavesaoc/python-snapcast). This interface controls client volume and assigns streams to groups. For a web interface in Python, see [snapcastr](https://github.com/xkonni/snapcastr), based on [python-snapcast](https://github.com/happyleavesaoc/python-snapcast). This interface controls client volume and assigns streams to groups.