Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (54 sloc) 1.85 KB

#Musik

A web-based streaming media library and player. Run Musik on your home server to gain unlimited access to your music collection from anywhere in the world.

##Getting Started

Prerequisites:

Clone the repo

git clone git@github.com:[username]/musik.git
cd musik

Set up a virtual environment using virtualenv (or virtualenvwrapper)

#virtualenv
virtualenv musik-venv --distribute

#virtualenvwrapper
mkvirtualenv musik-venv

Activate the virtual environment

#virtualenv
source musik-venv/bin/activate

#virtualenvwrapper
workon musik-venv

Install dependencies from your distribution's package manager

# Linux
sudo apt-get update
sudo apt-get install lame ffmpeg2theora vorbis-tools faac faad

# Mac (With Homebrew: http://mxcl.github.com/homebrew/)
brew install lame ffmpeg2theora vorbis-tools faac faad2

Most modern distributions will have some or all of these packages installed, so this step may or may not be necessary. Not all are required, but lame and vorbis-tools are recommended at minimum.

Install dependencies with pip

pip install -r requirements.txt

Run the musik server

python musik.py

The Musik server starts up by default on port 8080. You can change the port by modifying musik.cfg. point your browser at http://localhost:8080/

##Contributing

  1. Fork this repo
  2. Take a look at the issues. What needs to be done?
  3. Make a topic branch for what you want to do. Bonus points for referencing an issue (like 2-authentication).
  4. Make your changes.
  5. Create a Pull Request.
  6. Profit!