Update readme

This commit is contained in:
dave 2014-12-13 22:35:10 -08:00
parent 081f4d9271
commit b229886e32
2 changed files with 35 additions and 6 deletions

6
README
View File

@ -1,6 +0,0 @@
* Install docker
* Clone this repo
* Create an image using this dockerfile: `docker build -t rivendell .`
* Start a new container from the image: `docker run -d -p 5900 -p 8000 -p 22 rivendell`
TODO: Write more readme

35
README.md Normal file
View File

@ -0,0 +1,35 @@
Rivendell & Docker
==================
**How to use:**
* Install docker
* Clone this repo; cd into it
* Create an image in Docker: `docker build -t rivendell .`
* Start a new container using the image: `docker run -d -p 5900 -p 8000 -p 22 rivendell`
**Access:**
After using the exact commands above, `docker ps` will show you what ports on the docker host have been mapped to the container. Of course, you can use `-p hostport:containerport` like `-p 666:22` to specify what ports to use.
**SSH** *- exposed on port 22:* Username & password is **rduser**.
**VNC** *- exposed on port 5900:* Password is **rduser**
**Icecast** *- exposed on port 8000:* Admin panel is username **admin** password **rduser**. (No authorization needed to simply view streams.)
Known Issues
============
* Clicking 'Add' on the rdairplay window created by default causes the window to close. After bringing up another window (through xterm), the button functions normally.
* Apache occasionally needs a manual restart after the container is started. This *should* be fixed
Included packages
=================
* Rivendell - http://www.rivendellaudio.org/
* Jackd - http://jackaudio.org/
* Edcast for jackd - (and older version of) https://code.google.com/p/edcast-reborn/
* Icecast - http://icecast.org/
* Jamin - http://jamin.sourceforge.net/
* MySQL