Bug#270072: asterisk: README.Debian

[Tzafrir Cohen]

--f0KYrhQ4vYSV2aJu
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

163 days ago someone bitched about the package lacking a README.Debian.

I attach a slightly modified version of a README. I left some
rapid-specific parts but left some that I consider useful ;-)

-- 
Tzafrir Cohen     icq#16849755  +972-50-7952406
tzafrir.cohen@xorcom.com  http://www.xorcom.com

--f0KYrhQ4vYSV2aJu
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="README.Debian"

This file describes the changes in the Debian package from the original
asterisk package. 

File Locations
""""""""""""""
See /etc/asterisk/asterisk.conf .

Sounds reside at /usr/share/asterisk/sounds . Voicemail mailboxes, though
are under /var/spool/asterisk/voicemail using symlinks.

User, Groups, Permissions
"""""""""""""""""""""""""
By default the package will create user and group 'asterisk' and will 
run as them. It will also run with real-time priority (-p) . It will 
also add itself to the group audio to enable the daemon to access sound
cards.

To change those you can edit /etc/default/asterisk with defaults in
/etc/init.d/asterisk. If 'USER' is set to an empty value, asterisk will 
run as user root.

init.d Script Commands
""""""""""""""""""""""
In addition to reload, that runs the asterisk CLI command 'reload' there
are also extesions-reload ('extensions reload') and logger-reload 
('logger-reload') to load only parts of the configuration file. Let us
know if you find other partial reloads useful.

(currently Rapid-specific. Shouldn't be)
Asterisk needs gets a number of non-default paramters at startup with 
the init.d script. For debugging it is often useful to run 'asterisk -c'
or similar. However strange things may happen if you leave out the
options -U. Asterisk may write files with root ownership .

Thus we added the init.d script command 'debug' to start asterisk with
all the default options but also with '-cvvv' . If asterisk fails to
load for a reason you don't understand, try running:

  /etc/init.d/asterisk reload

to get a better clue


External Libraries
""""""""""""""""""
The package includes support for h323 . 

Include Globs and .d Directories
""""""""""""""""""""""""""""""""
(Rapid-specific)
Xorcom Rapid is patched to allow globbing with the '#include' directive
of the Asterisk configuration files. For instance, sip.conf has in its
end:

  #include "sip-phones.d/*.conf"

which includes all the .conf files in /etc/asterisk/sip-phones.d
Sip peers can thus be easily defined in a separate file without touching
any existing file. See the current configuration of Xorcom Rapid
for useful usage of this.


--f0KYrhQ4vYSV2aJu--