ADD v0.1.0-rc.4

Author: Jan Stabenow

CHANGELOG.md

@@ -1,3 +1,31 @@
+Changes from v0.1.0-rc.3 to v0.1.0-rc.4
+
+* Updates and extentions:
+  * NGINX 1.9.9 -> 1.10.2
+  * NGINX-RTMP -> latest Sergey-Version (fix-hls-playlist-length-on-varsize-fragments)
+  * FFmpeg 2.8.6 -> 3.1.2
+* added LUAJIT and the LUA-NGINX module
+* added NGINX exporter (status and metrics) for [Prometheus.io](https://prometheus.io)
+* switched to [certbot-auto](https://certbot.eff.org/) for better Let's Encrypt workflows
+* removed VTS module (heavy load with hls-chunks)
+* removed RTMP_AUTO_PUSH function (faulty)
+* modified (default) env:
+  * NEW:
+    * PLAYER_CREATE "true"
+    * PLAYER_WATERMARK_SOURCE "none"
+    * PLAYER_WATERMARK_POSITION "top-right"
+    * PLAYER_WATERMARK_LINK "none"
+    * PLAYER_COLOR_BUTTONS "3daa48"
+    * PLAYER_COLOR_SEEKBAR "3daa48"
+    * PLAYER_GA_ACCOUNT "none"
+    * PLAYER_GA_TRACKERNAME "datarheiEdge"
+  * RENAMED:
+    * HTTPS_CERT_DOMAIN -> HTTPS_SRV_CERT_DOMAIN
+    * HTTPS_CERT_CREATE -> HTTPS_LETSENCRYPT
+    * HTTPS_CERT_MAIL -> HTTPS_LETSENCRYPT_MAIL
+  * REMOVED:
+    * RTMP_AUTO_PUSH (faulty)
+
 Changes from v0.1.0-rc.2 to v0.1.0-rc.3
 
 * enabled rtmp-stats (html/xml/json)

Dockerfile

@@ -1,13 +1,20 @@
 FROM debian:jessie
 
 MAINTAINER datarhei <info@datarhei.org>
-
-ENV RESTREAMER_EDGE_VERSION=0.1.0-rc.3 \
-    FFMPEG_VERSION=2.8.6 \
+ENV RESTREAMER_EDGE_VERSION=0.1.0-rc.4 \
+    FFMPEG_VERSION=3.1.2 \
     YASM_VERSION=1.3.0 \
     LAME_VERSION=3_99_5 \
-    NGINX_VERSION=1.9.9 \
-    NGINX_RTMP_VERSION=1.1.7.10 \
+    NGINX_VERSION=1.10.2 \
+    NGINX_RTMP_VERSION=master \
+    NGINX_NJS=master \
+    NGINX_DEVEL_KIT_VERSION=0.3.0 \
+    NGINX_STUB_STATUS_PROM=master \
+    LUA_NGINX_MODULE_VERSION=0.10.7 \
+    LUAJIT_VERSION=2.0.4 \
+    LUAJIT_MAJOR_VERSION=2.0 \
+    LUAJIT_LIB=/usr/local/lib \
+    LUAJIT_INC=/usr/local/include/luajit-2.0 \
 
     SRC="/usr/local" \
     LD_LIBRARY_PATH="${SRC}/lib" \
@@ -16,8 +23,10 @@ ENV RESTREAMER_EDGE_VERSION=0.1.0-rc.3 \
     BUILDDEPS="autoconf automake gcc g++ libtool make nasm unzip zlib1g-dev libssl-dev xz-utils cmake build-essential libpcre3-dev"
 
 RUN rm -rf /var/lib/apt/lists/* && \
-    apt-get update --fix-missing && \
-    apt-get install -y --force-yes curl git libpcre3 tar perl ca-certificates apache2-utils libaio1 libxml2 libxslt-dev ${BUILDDEPS} && \
+    apt-get update && \
+    apt-get install -y --force-yes --fix-missing apt-utils && \
+    apt-get upgrade -y && \
+    apt-get install -y --force-yes --fix-missing curl git libpcre3 tar perl ca-certificates apache2-utils libaio1 libxml2 libxslt-dev ${BUILDDEPS} && \
 
     # yasm
     DIR="$(mktemp -d)" && cd "${DIR}" && \
@@ -62,12 +71,10 @@ RUN rm -rf /var/lib/apt/lists/* && \
     rm -rf "${DIR}" && \
 
     # ffmpeg
-    # patch: andrew-shulgin Ignore invalid sprop-parameter-sets missing PPS
     DIR="$(mktemp -d)" && cd "${DIR}" && \
     curl -LOks "https://ffmpeg.org/releases/ffmpeg-${FFMPEG_VERSION}.tar.gz" && \
     tar xzvf "ffmpeg-${FFMPEG_VERSION}.tar.gz" && \
     cd "ffmpeg-${FFMPEG_VERSION}" && \
-    curl -Lks "https://github.com/FFmpeg/FFmpeg/commit/1c7e2cf9d33968375ee4025d2279c937e147dae2.patch" | patch -p1 && \
     ./configure \
         --prefix="${SRC}" \
         --bindir="${SRC}/bin" \
@@ -97,25 +104,42 @@ RUN rm -rf /var/lib/apt/lists/* && \
     echo "${SRC}/lib" > "/etc/ld.so.conf.d/libc.conf" && \
     ffmpeg -buildconf && \
 
-    # nginx-rtmp
+    # LuaJIT
     DIR=$(mktemp -d) && cd ${DIR} && \
+    curl -LOks "http://luajit.org/download/LuaJIT-${LUAJIT_VERSION}.zip" && \
+    unzip LuaJIT-${LUAJIT_VERSION} && \
+    cd LuaJIT-${LUAJIT_VERSION} && \
+    make install && \
+    ln -sf luajit-${LUAJIT_VERSION} /usr/local/bin/luajit && \
+    rm -rf ${DIR}
+
+    # nginx-rtmp
+RUN DIR=$(mktemp -d) && cd ${DIR} && \
     curl -LOks "https://github.com/nginx/nginx/archive/release-${NGINX_VERSION}.tar.gz" && \
     tar xzvf "release-${NGINX_VERSION}.tar.gz" && \
-    curl -LOks "https://github.com/sergey-dryabzhinsky/nginx-rtmp-module/archive/v${NGINX_RTMP_VERSION}.tar.gz" && \
-    tar xzvf "v${NGINX_RTMP_VERSION}.tar.gz" && \
-    curl -LOks https://github.com/vozlt/nginx-module-vts/archive/master.zip && \
-    unzip master.zip && \
-    rm master.zip && \
-    curl -LOks https://github.com/nginx/njs/archive/master.zip && \
-    unzip master.zip && \
-    rm master.zip && \
+    curl -LOks "https://github.com/sergey-dryabzhinsky/nginx-rtmp-module/archive/${NGINX_RTMP_VERSION}.tar.gz" && \
+    tar xzvf "${NGINX_RTMP_VERSION}.tar.gz" && \
+    curl -LOks https://github.com/nginx/njs/archive/${NGINX_NJS}.zip && \
+    unzip ${NGINX_NJS}.zip && \
+    curl -LOks "https://github.com/simpl/ngx_devel_kit/archive/v${NGINX_DEVEL_KIT_VERSION}.zip" -O && \
+    unzip v${NGINX_DEVEL_KIT_VERSION}.zip && \
+    curl -LOks "https://github.com/openresty/lua-nginx-module/archive/v${LUA_NGINX_MODULE_VERSION}.zip" && \
+    unzip v${LUA_NGINX_MODULE_VERSION}.zip && \
+    curl -LOks "https://github.com/mhowlett/ngx_stub_status_prometheus/archive/${NGINX_STUB_STATUS_PROM}.zip" && \
+    unzip ${NGINX_STUB_STATUS_PROM}.zip && \
     cd nginx-release-${NGINX_VERSION} && \
     auto/configure \
         --with-http_ssl_module \
         --with-http_xslt_module \
-        --add-module="../nginx-module-vts-master" \
-        --add-module="../njs-master/nginx" \
-        --add-module="../nginx-rtmp-module-${NGINX_RTMP_VERSION}" && \
+        --with-ld-opt="-Wl,-rpath,/usr/local/lib/lua" \
+        --with-http_ssl_module \
+        --with-http_realip_module \
+        --with-http_stub_status_module \
+        --add-dynamic-module="../njs-${NGINX_NJS}/nginx" \
+        --add-dynamic-module="../nginx-rtmp-module-${NGINX_RTMP_VERSION}" \
+        --add-module="../ngx_devel_kit-${NGINX_DEVEL_KIT_VERSION}" \
+        --add-module="../lua-nginx-module-${LUA_NGINX_MODULE_VERSION}" \
+        --add-dynamic-module="../ngx_stub_status_prometheus-${NGINX_STUB_STATUS_PROM}" && \
     make -j"$(nproc)" && \
     make install && \
     cp ../nginx-rtmp-module-${NGINX_RTMP_VERSION}/stat.xsl /usr/local/nginx/html/info.xsl && \
@@ -127,8 +151,9 @@ RUN rm -rf /var/lib/apt/lists/* && \
 
     # letsencrypt
     cd /opt && \
-    git clone https://github.com/letsencrypt/letsencrypt letsencrypt && \
-    letsencrypt/letsencrypt-auto --os-packages-only && \
+    curl -LOks https://dl.eff.org/certbot-auto && \
+    chmod a+x ./certbot-auto && \
+    ./certbot-auto --os-packages-only --noninteractive && \
 
     # clappr-player
     DIR=$(mktemp -d) && cd ${DIR} && \
@@ -141,6 +166,10 @@ RUN rm -rf /var/lib/apt/lists/* && \
     mv * /usr/local/nginx/html && \
     rm -rf ${DIR} && \
 
+    # prometheus exporter
+    cd /usr/local/nginx/ && \
+    curl -LOks "https://raw.githubusercontent.com/knyar/nginx-lua-prometheus/master/prometheus.lua" && \
+
     apt-get purge -y --auto-remove ${BUILDDEPS} && \
     apt-get clean -y && \
     rm -rf /var/lib/apt/lists/* \
@@ -215,8 +244,21 @@ ENV WORKER_PROCESSES=1 \
 
     HTTPS_SRV=false \
     HTTPS_SRV_PORT=443 \
-    HTTPS_CERT_CREATE=true \
-    HTTPS_CERT_MAIL=admin@example.org \
-    HTTPS_CERT_DOMAIN=example.org
+    HTTPS_SRV_CERT_DOMAIN=example.org \
+    
+    HTTPS_LETSENCRYPT=false \
+    HTTPS_LETSENCRYPT_MAIL=admin@example.org \
+    
+    PLAYER_CREATE=true \
+    
+    PLAYER_WATERMARK_SOURCE=none \
+    PLAYER_WATERMARK_POSITION=top-right \
+    PLAYER_WATERMARK_LINK=none \
+
+    PLAYER_COLOR_BUTTONS=3daa48 \
+    PLAYER_COLOR_SEEKBAR=3daa48 \
+
+    PLAYER_GA_ACCOUNT=none \
+    PLAYER_GA_TRACKERNAME=datarheiEdge
 
 CMD ["/run.sh"]

README.md

@@ -17,7 +17,8 @@ Currently the Restreamer-Edge is very plain and bash based application without u
 
 * [NGINX](http://nginx.org/) open source web server for high traffic
 * [NGINX-RTMP-Module](https://github.com/arut/nginx-rtmp-module) as streaming-backend and HLS server
-* [NGINX virtual host traffic status module](https://github.com/vozlt/nginx-module-vts) for http/hls-stats
+* [NGINX Stub Status](https://github.com/mhowlett/ngx_stub_status_prometheus) for Prometheus.io
+* [NGINX Metrics](https://github.com/knyar/nginx-lua-prometheus) for Prometheus.io
 * [NJS](https://github.com/nginx/njs) for the rtmp-authentification
 * [Clappr-Player](https://github.com/clappr/clappr) as HLS-player to embed your stream upon your website (no Adobe Flash)
 * [FFmpeg](http://ffmpeg.org) to create snapshots and live-transcode (if enabled) each is pushing streams to 240p, 360p, 480p and 720p
@@ -76,19 +77,36 @@ Available profiles are: 240p, 360p, 480p, 720p and native
   -e "HTTP_ACCESS_LOG=/dev/stdout" 
 ```
 
-#### Enable HTTPS/SSL:
+#### Enable HTTPS/SSL and Let's Encrypt:
 
 ```sh
   -e "HTTPS_SRV=true" 
-  -e "HTTPS_CERT_MAIL=admin@example.org" 
-  -e "HTTPS_CERT_DOMAIN=example.org,example.com" 
+  -e "HTTPS_SRV_CERT_DOMAIN=example.org,example.com" 
+  -e "HTTPS_LETSENCRYPT=true"
+  -e "HTTPS_LETSENCRYPT_MAIL=admin@example.org"
   -p 443:443
   -v /mnt/restreamer-edge/letsencrypt:/etc/letsencrypt
 ```
 
 *Port 80/443 have to be forwarded to the Restreamer-Edge and the destination of your Domains have to be your host IP-Address!* 
 
-*["Error creating new cert :: Too many certificates already issued for exact set of domains"](https://community.letsencrypt.org/t/public-beta-rate-limits/4772) - use -e "HTTPS_CERT_CREATE=false" if your cert is already installed*
+##### To auto renew your Let's Encrypt certificat you can use cron/systemd like:
+
+```sh
+  0 0 * * * /usr/bin/docker restart restreamer-edge >/dev/null 2>&1
+```
+
+#### Customize your Player
+
+```sh
+  -e "PLAYER_WATERMARK_SOURCE=http://datarhei.org/logo.png" 
+  -e "PLAYER_WATERMARK_POSITION=top-left" 
+  -e "PLAYER_WATERMARK_LINK=http://datarhei.org" 
+  -e "PLAYER_COLOR_BUTTONS=000000" 
+  -e "PLAYER_COLOR_SEEKBAR=000000"
+  -e "PLAYER_GA_ACCOUNT=UE123456"
+  -e "PLAYER_GA_TRACKERNAME=datarheiDemoEdge1"
+```
 
 ## Usage
 
@@ -99,16 +117,20 @@ Available profiles are: 240p, 360p, 480p, 720p and native
 2. open the Edge-Player on your browser:   
    http://[your-edge-ip]:[http-port]/index.html?stream=mystream
 
-#### HTTP stat:
-
-![VTS Stats](docs/edge-stats.png)
+#### NGINX-Exporter for Prometheus.io:
 
-1. Open the VTS page:   
+1. Open stauts page:  
    http://[your-edge-ip]:[http-port]/status   
 2. Enter your login data is set by:  
   ```-e HTTP_AUTH_USERNAME=your-username```   
   ```-e HTTP_AUTH_PASSWORD=your-password```
 
+1. Open metrics page:  
+   http://[your-edge-ip]:[http-port]/metrics   
+2. Enter your login data is set by:  
+  ```-e HTTP_AUTH_USERNAME=your-username```   
+  ```-e HTTP_AUTH_PASSWORD=your-password```
+
 #### RTMP stat
 
 1. Open "http://[your-edge-ip]:[http-port]/rtmp-stat"
@@ -124,14 +146,14 @@ Available profiles are: 240p, 360p, 480p, 720p and native
 
 * NGINX [description](http://nginx.org/en/docs/ngx_core_module.html)
 * NGINX RTMP [description](https://github.com/sergey-dryabzhinsky/nginx-rtmp-module/blob/master/doc/directives.md)
-* NGINX VTS [description](https://github.com/vozlt/nginx-module-vts)
+* Clappr-Player [description](https://github.com/clappr/clappr/blob/master/doc/BUILTIN_PLUGINS.md)
 
 #### Default values
 
 ```sh
 WORKER_PROCESSES "1"
 WORKER_CONNECTIONS "1024"
-    
+
 RTMP_ACCESS_LOG "off"
 
 RTMP_SRV_PORT "1935"
@@ -143,15 +165,15 @@ RTMP_SRV_ACK_WINDOW "5000000"
 RTMP_SRV_CHUNK_SIZE "4096"
 RTMP_SRV_MAX_MESSAGE "1M"
 RTMP_SRV_BUFLEN "5s"
-    
+
 RTMP_SRV_APP_HLS_INTERLEAVE "on"
 RTMP_SRV_APP_HLS_META "copy"
 RTMP_SRV_APP_HLS_WAIT_KEY "on"
 RTMP_SRV_APP_HLS_WAIT_VIDEO "on"
 RTMP_SRV_APP_HLS_DROP_IDLE_PUBLISHER "10s"
 RTMP_SRV_APP_HLS_SYNC "10ms"
 RTMP_SRV_APP_HLS_IDLE_STREAMS "off"
-    
+
 RTMP_SRV_APP_HLS_HLS_FRAGMENT "2s"
 RTMP_SRV_APP_HLS_HLS_PLAYLIST_LENGTH "60"
 RTMP_SRV_APP_HLS_HLS_SYNC "1ms"
@@ -164,7 +186,7 @@ RTMP_SRV_APP_HLS_HLS_FRAGMENT_SLICING "plain"
 RTMP_SRV_APP_HLS_HLS_TYPE "live"
 RTMP_SRV_APP_HLS_HLS_KEY "off"
 RTMP_SRV_APP_HLS_HLS_FRAGMENTS_PER_KEY "0"
-    
+
 RTMP_SRV_APP_HLS_SNAPSHOT_INTERVAL "60"
 RTMP_SRV_APP_HLS_TRANSCODING "false"
 RTMP_SRV_APP_HLS_TRANSCODING_PROFILES "240p,360p,480p,720p,native"
@@ -181,12 +203,25 @@ HTTP_SRV_LOC_HLS_ACCESS_CONTROL_ALLOW_ORIGIN "*"
 
 HTTP_AUTH_USERNAME "admin"
 HTTP_AUTH_PASSWORD "datarhei"
-    
+
 HTTPS_SRV "false"
 HTTPS_SRV_PORT "443"
-HTTPS_CERT_CREATE "true"
-HTTPS_CERT_MAIL "admin@example.org"
-HTTPS_CERT_DOMAIN "example.org"
+HTTPS_SRV_CERT_DOMAIN "example.org"
+
+HTTPS_LETSENCRYPT "false"
+HTTPS_LETSENCRYPT_MAIL "admin@example.org"
+
+PLAYER_CREATE "true"
+
+PLAYER_WATERMARK_SOURCE "none"
+PLAYER_WATERMARK_POSITION "top-right"
+PLAYER_WATERMARK_LINK "none"
+
+PLAYER_COLOR_BUTTONS "3daa48"
+PLAYER_COLOR_SEEKBAR "3daa48"
+
+PLAYER_GA_ACCOUNT "none"
+PLAYER_GA_TRACKERNAME "datarheiEdge"
 ```
 
 ## Hosting examples

edge.env

@@ -31,7 +31,7 @@ RTMP_SRV_APP_HLS_HLS_KEY=off
 RTMP_SRV_APP_HLS_HLS_FRAGMENTS_PER_KEY=0
 RTMP_SRV_APP_HLS_SNAPSHOT_INTERVAL=60
 RTMP_SRV_APP_HLS_TRANSCODING=false
-RTMP_SRV_APP_HLS_TRANSCODING_PROFILES=240p,360p,480p,720p,native  
+RTMP_SRV_APP_HLS_TRANSCODING_PROFILES=240p,360p,480p,720p,native
 RTMP_PUBLISH_TOKEN=datarhei
 HTTP_SENDFILE=on
 HTTP_TCP_NOPUSH=on
@@ -43,6 +43,14 @@ HTTP_AUTH_USERNAME=admin
 HTTP_AUTH_PASSWORD=datarhei
 HTTPS_SRV=false
 HTTPS_SRV_PORT=443
-HTTPS_CERT_CREATE=true
-HTTPS_CERT_MAIL=admin@example.org
-HTTPS_CERT_DOMAIN=example.org
+HTTPS_SRV_CERT_DOMAIN=example.org
+HTTPS_LETSENCRYPT=false
+HTTPS_LETSENCRYPT_MAIL=admin@example.org
+PLAYER_CREATE=false
+PLAYER_WATERMARK_SOURCE=none
+PLAYER_WATERMARK_POSITION=top-right
+PLAYER_WATERMARK_LINK=none
+PLAYER_COLOR_BUTTONS=3daa48
+PLAYER_COLOR_SEEKBAR=3daa48
+PLAYER_GA_ACCOUNT=none
+PLAYER_GA_TRACKERNAME=datarheiEdge