[SCM] crtmpserver/master: Updated README.Debian to reflect the new release

[Reinhard Tartler]

In general, excellent idea to document these steps!

A couple of suggestions, though:

On So, Nov 20, 2011 at 16:34:39 (CET), jet-guest at users.alioth.debian.org wrote:

> The following commit has been merged in the master branch:
> commit 2ddf9e0e566e02b027fbb6fec9f2d20ba6c63338
> Author: Andriy Beregovenko <jet at jet.kiev.ua>
> Date:   Sun Nov 20 17:34:26 2011 +0200
>
>     Updated README.Debian to reflect the new release
>
> diff --git a/debian/README.Debian b/debian/README.Debian
> index 3107e90..0373b55 100644
> --- a/debian/README.Debian
> +++ b/debian/README.Debian
> @@ -1,78 +1,61 @@
> -crtmpserver for Debian
> +crtmpserver for Debian
>  ======================

Unnecessary ' '

>  
>  Introduction
>  ------------
>  The crtmpserver can provide powerful platform for processing several families
>  of media streaming protocols. By default it support next protocol families:
> -RTMP, RTSP, RTP/RTCP, MPEG-TS
> -
> -
> -0. Post install configuration
> ------------------------------
> -To complete installation as a system service, we need to do a few more steps:
> - 1. Create system wide daemon user
> - 2. Create directories for logs and configuration
> - 3. Add init.d script and daemon start defaults file
> - 4. Add basic daemon configuration
> - 5. Running daemon
> -
> -
> -1. Create system wide daemon user
> ----------------------------------
> - You must add system user for daemon. Something like this:
> -adduser --system --disabled-login --ingroup adm --home /var/lib/crtmpserver \
> -        --gecos crtmpserver --shell /bin/false crtmpserver
> -
> -
> -2. Create directories for logs and configuration
> -------------------------------------------------
> - Need to create next directories:
> -/etc/crtmpserver
> -/var/log/crtmpserver
> -
> -Note:
> -Since daemon initialize log file BEFORE privileges will be reduced, no need
> -to change owner to user "crtmpserver" for this dirs.
> -
> -
> -3. Add init.d script and daemon start defaults file
> ----------------------------------------------------
> - Example(and working) init.d script is placed in:
> -/usr/share/doc/crtmpserver/examples/crtmpserver.init
> -Also there is "defaults" file:
> -/usr/share/doc/crtmpserver/examples/crtmpserver.default
> -To enable daemon starting just do next(using root previlegies):
> -
> -Copy init script:
> - cp /usr/share/doc/crtmpserver/examples/crtmpserver.init \
> -    /etc/init.d/crtmpserver
> -
> -Copy default file:
> - cp /usr/share/doc/crtmpserver/examples/crtmpserver.default \
> -    /etc/default/crtmpserver
> -
> -Install rc.d links:
> - update-rc.d crtmpserver start 90 2 3 5 . stop 10 2 3 5
> -
> -
> -4. Add basic daemon configuration
> ----------------------------------
> - Sample configuration file is placed in:
> -/usr/share/doc/crtmpserver/examples/crtmpserver.lua.gz
> -
> -To set this file as configuration do next:
> -
> -Copy it:
> - cp /usr/share/doc/crtmpserver/examples/crtmpserver.lua.gz \
> -    /etc/crtmpserver
> -
> -Extract it:
> - cd /etc/crtmpserver ; gunzip crtmpserver.lua.gz
> -
> -
> -5. Running daemon
> ------------------
> - After all steps described above just do next:
> -/etc/init.d/crtmpserver star
> +RTMP, RTSP, RTP/RTCP, MPEG-TS, MMS.
> +
> +1. Changes from last package version
> +------------------------------------
> + * There are several major updates and improvements between previous version
> +   svn474 and new svn611:
> +     - RTSP support was completely remade;
> +     - added MMS support;
> +     - added HLS support;
> +     - several improvements in MPEG-TS protocol.
> + * Package was divided to 4 packages: 
> +     - crtmpserver-libs, with 'thelib' and 'common' inside. Now you do not 
> +       need to install all if you have very customized own build.
> +     - crtmpserver-apps, default applications which provides by upstream.
> +     - crtmpserver-dev, headers for 'thelib' and 'common' libs.
> +     - crtmpserver, main daemon binary and startup scripts.
> + * Implemented a new system startup for daemon. Upstream configuration file
> +   was devided to parts: logger configuration script, applications.
> +   

What is the 'last' package version? In five uploads from now, this will
heavily confuse the reader. I'd therefore suggest to place this in
NEWS.Debian.

> +2. New startup script system
> +----------------------------
> +Now all application configuration are placed in /etc/crtmpserver/applications.
> +To enable any of them, simple add script base name(without .lua extention) to 
> +file /etc/crtmpserver/enabled_applications.conf. 
> +
> +Main configuration script now only generate config from parts. It load logger
> +configuration script /etc/crtmpserver/log_appenders.lua, after this, script 
> +read file /etc/crtmpserver/enabled_applications.conf and load application 
> +scripts (using next filename form /etc/crtmpserver/applications/$name.lua)
> +
> +Also, now provided file /etc/defaults/crtmpserver for more comfortable daemon 
> +maintaining.
> +
> +
> +3. Change daemon user. 
> +-------------------------------
> +By default daemon run with root privileges, but you can change this behavior.
> +Next steps allows you to change daemon user:
> + a) Create system wide daemon user
> +	You must add system user for daemon. Something like this:
> +	adduser --system --disabled-login --ingroup adm \
> +		--home /var/lib/crtmpserver \
> +		--gecos crtmpserver \
> +		--shell /bin/false \
> +		crtmpserver
> +
> + b) Change daemon user
> +	Open rc configuration file /etc/defaults/crtmpserver, and 
> +	change DAEMON_USER to created user name(in our case this is 'crtmpserver')
> +
> + c) Restart daemon
> +	After all steps described above just do next:
> +	 /etc/init.d/crtmpserver restart

These texts are great. I'd drop the numbering, though.

Cheers,
Reinhard

-- 
Gruesse/greetings,
Reinhard Tartler, KeyID 945348A4