Skip to content
This repository has been archived by the owner on Apr 14, 2020. It is now read-only.

Commit

Permalink
v1.0.0: Make docker image examples simpler
Browse files Browse the repository at this point in the history
  • Loading branch information
Ullaakut authored May 11, 2017
1 parent 98088f6 commit a31c168
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@

* `docker`

## Using the CES docker image
1. `git clone [email protected]:EtixLabs/CES.git`
2. `cd CES`
3. `docker run [-e RTSP_LISTEN_ADDRESS=your_listen_address] [-e RTSP_PORT=your_port -p your_port:your_port] [-e RTSP_PATH=your_path] [-e RTSP_INPUT_STREAM=your_input_stream] [-e RTSP_USERNAME=your_username] [-e RTSP_PASSWORD=your_password] [-e RTSP_RESOLUTION='your_width'x'your_height'] [-e RTSP_FRAMERATE=your_framerate] [-e GST_DEBUG=your_debug_level] ullaakut/CES`
## Examples of use

To create a simple test stream, just launch `docker run -p 8554:8554 ullaakut/CES` and access it on the URL `rtsp://0.0.0.0:8554/live.sdp`

To create a test stream with credentials, just add the RTSP_PASSWORD and RTSP_USERNAME arguments like so : `docker run -p 8554:8554 -e RTSP_PASSWORD=mypass -e RTSP_USERNAME=myusername` and then access it on the URL `rtsp://myusername:[email protected]:8554/live.sdp`.

### Usage

`docker run [-e RTSP_LISTEN_ADDRESS=your_listen_address] [-e RTSP_PORT=your_port -p your_port:your_port] [-e RTSP_PATH=your_path] [-e RTSP_INPUT_STREAM=your_input_stream] [-e RTSP_USERNAME=your_username] [-e RTSP_PASSWORD=your_password] [-e RTSP_RESOLUTION='your_width'x'your_height'] [-e RTSP_FRAMERATE=your_framerate] [-e GST_DEBUG=your_debug_level] ullaakut/CES`

### Parameters

All of these options override the default parameters for CES
* `your_listen_address`: The address you want your server to listen on [default: `0.0.0.0`]
Expand Down

0 comments on commit a31c168

Please sign in to comment.