Kissdx user manual: Management

From Kissdx-wiki

(Redirected from Kissdx user manual: Adminsitration Command v01400)

Home : Home >

1 Management of kissdx

Management of kissdx

Administration of kissdx streaming media server is available through a command line utility which is kissdx itself.

Once your kissdx server is started and listens on an administration TCP port, as specified in its configuration file, you are able to control it remotely. Therefore, the utility may be run on the same host or from a remote host, with the same behavior.

The current administration commands allow you to stop your streaming server gracefuly (this avoids a CTRL C or kill command) and to manage the configuration (view, reload). The set of commands is growing with successive releases of kissdx.

This feature is based on TCP communications between the streaming server and the client utility. Make sure to allow data on this TCP port between those two hosts. Refer to the full description of kissdx network architecture for more details.

[edit]

Synopsis overview of administration command

Here is an extract from the command line help screen:

Usage: ./kissdx [media center options] | [admin options]

kissdx streaming server is known as  : the media center
kissdx admin utility    is knwon as  : the administration command utility

Administration options: [-s (command)] [-m (mediacenter)] [-p (port)]
-----------------------
       -s, --send COMMAND      Invoke admin controler with COMMAND
       -m, --mediacenter       Target name/IP to send command (dft: localhost)
       -p, --port              TCP port to send admin command

Administration 'send' options: [-s (command)] 
------------------------------
       -s STOP                 Stop gracefully kissdx mediacenter
       -s FORCESTOP            Stop drasticaly kissdx mediacenter
       -s RELOAD_CONFIG        Reload configuration file
       -s GET_TXT_CONFIG       Get current configuration loaded

Sample:
-------
 ./kissdx -v -s STOP                             Graceful stop : current streaming continue)
 ./kissdx -s STOP -p 8003 -m media.home.fr       Remote stopping of a media center

Tip: If you have followed the recommendation of tcp port 8003 for the streaming server, and run the utility locally on the same host as the server, default values of localhost and 8003 allow a reduced command line:

./kissdx -s STOP   is enough to establish an administration connection and send your request

[edit]

STOP administration command

The STOP administration command tells kissdx streaming server:

No new requests for media streaming should be accepted.
Proceed with any current streaming to KiSS player until streaming ends.

When all current streaming has ended, kissdx streaming server stops running. The 'kissdx' process will terminate.

In order to restart kissdx, you should run a command line like ./kissdx -dc /etc/kissdx.conf

[edit]

FORCESTOP administration command

The FORCESTOP administration command tells kissdx streaming server:

No new requests for media streaming should be accepted.
Stop immediately any current streaming to KiSS players without waiting for them to end.

When all current streaming has been stopped, kissdx streaming server stops running. The 'kissdx' process will terminate.

In order to restart kissdx, you should run a command line like ./kissdx -dc /etc/kissdx.conf

[edit]

RELOAD_CONFIG administration command

The RELOAD_CONFIG administration command tells kissdx streaming server:

Proceed with any current streaming to KiSS players as normal.
Reload the configuration from the kissdx.conf file, and continue accepting new request for media streaming.

The settings for the running kissdx server are updated with your latest changes.

Note that multiple locations of the kissdx configuration file is supported. The search order is as follows (1 is read first, 4 is read last if not found in 1,2 or 3):

location specified in command line argument: kissdx -c full-path-to-config-file
~/.kissdx (~/ means /home/{your_user}/ )
./kissdx.conf
/etc/kissdx.conf

Since the search will stop when the first kissdx configuration file found, a different file may be loaded than when kissdx was originally launched. See the following context :

Originally kissdx streaming server was launched with an existing /etc/kissdx.conf configuration file.
A new ~/.kissdx configuration file is created.
When the 'Reload_config' command is executed, the configuration is read from ~/.kissdx even if /etc/kissdx.conf still exists.

Note also that if the configuration file found has errors in it, it will be rejected and the current configuration is unchanged. A message appears on the console or in the syslog like the following. It explains that the original file /etc/kissdx.conf was correct and allowed kissdx to start the first time. But since, the configuration file has been changed and now has errors. A reminder of the original configuration location should help debugging.

[ 8250] 2007-10-10 21:57:41 =============================================================
[ 8250] 2007-10-10 21:57:41 ... Ready for streaming business
[ 8250] 2007-10-10 21:57:41 Server signature : ubuntugsi.homeip.net-v0.13.x/2007-09-01 (OK)
....
[ 8250] 2007-10-10 22:01:36 Received identity request from 10.39.10.5
[ 8250] 2007-10-10 22:01:36 Reading configuration file '/etc/kissdx.conf'
[ 8250] 2007-10-10 22:01:36 Unknown option in config file: jconfigautoload
[ 8250] 2007-10-10 22:01:36 Error(s) in the configuration file prevent kissdx from using the file.
[ 8250] 2007-10-10 22:01:36 Loading new config failed from   : /etc/kissdx.conf
[ 8250] 2007-10-10 22:01:36 Keep previous configuration from : /etc/kissdx.conf
[ 8250] 2007-10-10 22:01:36 =============================================================

[edit]