Skip to content

Latest commit

 

History

History
147 lines (98 loc) · 2.9 KB

README.md

File metadata and controls

147 lines (98 loc) · 2.9 KB
Raw

snapcastr

introduction

Snapcastr is a webinterface to control a snapcast server.

It is written in python with flask, wtforms and python-snapcast

install from source or from pypi

install from source

requirements

use your package manager, e.g. apt or pacman and install

  • python3
  • poetry

get source

$ git clone https://github.com/xkonni/snapcastr

install locally

$ cd snapcastr
$ poetry install

install system-wide

$ cd snapcastr
$ poetry build
$ sudo pip3 install dist/snapcastr-0.1.0.tar.gz

install from pypi

install locally

$ pip install snapcastr

install system-wide

$ sudo pip install snapcastr

run

show help

$ snapcastrd -h

usage: snapcastrd [-h] [--host host] [--port port] [--sc_host sc_host] [-c CONFIG] [-d]

snapcastr

optional arguments:
  -h, --help            show this help message and exit
  --host host           webinterface host
  --port port, -p port  webinterface port
  --sc_host sc_host, -s sc_host
                        snapcast host
  -c CONFIG, --config CONFIG
                        config file
  -d, --debug           debug mode

run the application

  • when installed locally
$ cd snapcastr
$ poetry run snapcastrd --sc_host=address_of_your_snapserver
  • when installed system-wide
$ snapcastrd --sc_host=address_of_your_snapserver

The address_of_your_snapserver might be 127.0.0.1 or localhost, if you are running snapcastr on the same machine as your snapserver. Snapcastr doesn't need to run with super user privileges (so you don't need to run it with sudo).

config

The last used configuration is saved in $HOME/.config/snapcastr.json and can also be edited.

access webinterface

When the application is running, open http://localhost:5000 in your browser.

features

main screen

  • View general status, number of clients, streams, groups of clients main

clients

  • View connected clients and change their volume clients

groups

  • View the groups and the stream being played by each group groups

streams

  • View the status of the various streams available streams

roadmap, in no particular order

clients

  • rename
  • remove old

groups

  • rename
  • remove
  • add

streams

  • rename