################################################################
# IRLP Voicemail Project
#
# By: Ted G. Freitas (KE6YJC)
#     E-Mail: ke6yjc@ke6yjc.org
#     Web: http://www.ke6yjc.org/
#
# IRLP Node: 8340 - Fresno, CA
#
################################################################

The following scripts are without warranty. I will take no
responsibilty for any damage caused to your system or IRLP
node.

###########
Portability
###########

A quick word on portability:  I've tried to the best of my ability and means
to make this voicemail system as portable as possible.  I've only tested
it under RedHat versions 7.3 and 8.0, however *ALL* testing has been on the 
Intel x86 architecture.

############
Requirements
############

The only know requirements is that you have a functioning IRLP system, the
following VM scripts with the appropriate wav files. All scripts have been
written in Bournce shell so this will be needed as well.

############
Installation
############

1. copy the irlp_voicemail.tgz file to /tmp
   ex: cp irlp_voicemail.tgz /tmp

2. extract files to /tmp directory
   ex: tar zxvf /tmp/irlp_voicemail.tgz -C /tmp

3. run install script (must be su - repeater)
   ex: /tmp/install

4. add the following lines to your custom_decode file:

if [ -f "$LOCAL"/voicemail ] ; then "$CUSTOM"/vm/`/bin/cat "$LOCAL"/voicemail` $1 ; exit 1 ; fi
if [ "$1" = "900" ] ; then "$CUSTOM"/voicemail ; exit 1 ; fi

The 1st if statement checks to see if the voicemail system is currently
activated. The next line fires off the voicemail scripts.

############################
IRLP Voicemail Configuration
############################

/conf/vm.conf

This file should be fine as it stands but you never know when you might
want to change something. The file is pretty self explanitory.

Make sure VM_ENV is set to TRUE or scripts will not function properly!
VM_ENV=TRUE

This tells the scripts where the audio files are
VMAUDIO=/home/irlp/audio/custom/vm

This is where the root folder for the users are
VMUSERDIR=/home/irlp/custom/vm/users

This is the location for the password file and node list. More things will
be added as time goes on and more scripts are implemented
VMDB=/home/irlp/custom/vm/dbase

Just like it sounds, temp area for everything the scripts do.
VMTMP=/home/irlp/custom/vm/tmp

Voicemail Scripts location
VMSCRIPT=/home/irlp/custom/vm

/dbase/password.txt

This file contains the user Callsign, UserID, and Password. The format
is pretty straight forward.

--snip--
KE6YJC 100 123
--snip--

The following snip shows my callsign as KE6YJC my UserID is 100 and my
password is 123. Each user must be on an indivigual line. You can not
run them together.

/dbase/nodefile.txt

This is for future gateway use!

/config/notify.txt

This file is used for e-mail, cell or pager notification of new voicemail
messages. The system will attempt to send an smtp message to the noticication
e-mail address. The contents of the notify.txt file will be the alert that
is sent.

##########
User Setup
##########

To setup a new user run the vm_adduser script. The formation for the script
is vm_adduser CALLSIGN PASSWORD NOTIFICATION-ADDR. This script must be
executed from the $VM_SCRIPT directory.

ex: vm_adduser ke6yjc 123 ke6yjc@ke6yjc.org

All information will be displayed back on the screen so you can email it
to the end user.

You will need to record their callsign.wav file and greeting.wav file. The
user can currently update their greeting.wav file by going to the custom
menu (option 8 from the main menu)

In the future when a user logs onto their mailbox for the first time there
will be a voicemail box setup script that will launch and setup all necessary
audio files.