Thank you for choosing SIDVault as your database storage solution. SIDVault requires no extra software or libaries to be installed. For any support questions or issues please Email:

sidvault@alphacentauri.co.nz

Before installing SIDVault you need to think about

• Servers already on your system

  You will need to stop any running LDAP server. If you already have SIDVault running the installer will take care of shutdown the server before upgrading any files.

  How to check for other servers:

  Enter the following at a command prompt in order to check if you have a LDAP server running,
      telnet localhost 389
  If something responded then you need to stop it You should consult your LDAP server's manualy about how to shutdown the LDAP server.

  (Not sure how to close the telnet session? : if something responded, use CTRL-], CTRL-C on UNIX based telnet)

• Running on non-standard ports:

  Alternatively, SIDVault on install detects that that the stardard port 389 is still in use will prompt you for an alterative port. SIDVault will take care of the sidvault.ini changes that are needed. So that they operate without interference with the operation of other LDAP servers.

• Other points to consider:

  Public IP's should not be used without major filtering in the Router ACL and the firewall. You have the high risk of exposing all subscriber data using a wildcard LDAP query. Under many countries laws, this is a violation of data protection rules.

SIDVault is very easy to install, all you need to do it run the installer. You do not need to download or install any c or perl libraries, and no compiler is required.

First you need to goto SIDVault download page download the correct version for your operating system. If you are running Windows all you need do is run the download, it will then self-extract the files and run the SIDVault install for you.

On linux once you have downloaded you need to un-gzip and untar the download.

ie.   gzip -d *gz
       tar -xvf sidvault20a_lunux.tar.Z

Then you move into the sidvault directory and run the installer. You must been running as the root user to correctly install sidvault

ie.   cd sidvault
      ./install.sh

Once the installer has finished installing all you do is then activate SIDVault by using your web browser and connection to the built in webserver setup on port 6680.

ie.   http://127.0.0.1:6680/
or    http://your.hostname.com:6680/ to run LDAP Web Admin remotely.

Once installed login to the managers web interface your 30 day free trial version should be activated.

If you have any questions please Email:    sidvault@alphacentauri.co.nz

SIDVault has the uninstaller built into the server. To uninstall you need to run sidvault like this:

ie.   cd /usr/local/sidvault
      ./sidvault -uninstall

This will then ask you which type of uninstall you wish, A full unstall or just stop SIDVault from starting on Boot up. When you do a full uninstall all SurgeDLAP will be stopped and ALL the data within SIDVault and remove every file and folder from teh sidvault workarea (/usr/local/sidvault).

In most cases, the install will configure your machine to start SIDVault automatically upon reboot. If SIDVault does not start automatically, you will need to modify your system startup scripts.

Windows Platforms:

The installation program adds the sidvault service to the list of services on Windows NT machines. So the SIDVault server should start at startup. You can edit the sidvault startup options in the Services dialog of Control Panel.

On non-NT windows platforms the installation utility will add the registry key "SIDVault" to HKEY_LOCAL_MACHINE - SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\RunServices

You can also simply add a shortcut for the sidvault.exe executable to your startup menu. This option can be good for testing as you can easily kill any subprocesses from the task manager.

UNIX-based Platforms:

The installation utility should have added lines to your startup script to start the sidvault process at startup, unless you instructed it not to start the servers.

It will generally create a sidvault.init file (i.e. /etc/rc.d/init.d/sidvault.init) and appropriate links to it for the different run levels. If it hasn't been able to do this then it tries to add startup lines to the file, /etc/rc.d/rc.local

If the installer has put them in the wrong place or cannot find the startup script, then you should add the following two lines to your system's equivalent of the file /etc/rc.d/rc.local

rm -f /usr/local/sidvault/*.pid
/usr/local/sidvault/start.sh

The start.sh script starts sidvault, which in turn starts all the SIDVault components.

The notes below have general information on where to put these scripts and situations where they need editing, along with an example runlevel startup script.

NOTES:

1. The startup scripts set a limit on core file dumps, so that if the program dies, a core file is created which is very helpful for finding the bug. For most systems:

   ulimit -c 20000

   sets this. Unfortunately, the SIDVault scripts used not to have the correct first line,

   !#/bin/sh

   in them to run the sh shell. So you should check that all of the files,

   /usr/local/sidvault/start.sh
   /usr/local/sidvault/stop.sh
   

   start with that line.

   The 'not as good alternative' is that you check that this command is valid for your shell, you may need to change it to, for example, (for csh shell),

   limit coredumpsize 20000

2. If your system does not have either of these files:

   /etc/rc.d/init.d/sidvault.init
   /etc/rc.d/rc.local

   then be assured that dmsetup will not have put the startup script lines anywhere else. So you need to do it manually.
3. If you are having trouble locating where to put the startup lines, search for where sendmail's startup scripts are.

   For example, the file

   /etc/rc.d/init.d/sendmail

   is often sendmail's startup script, which looks like this:

   *****File Content Within Stars *****
   #!/bin/sh
   #
   # sendmail This shell script takes care of starting and stopping
   # sendmail.
   #
   # chkconfig: 2345 80 30
   # description: Sendmail is a Mail Transport Agent, which is the program \
   # that moves mail from one machine to another.
   # processname: sendmail
   # config: /etc/sendmail.cf
   # pidfile: /var/run/sendmail.pid
   
   # Source function library.
   . /etc/rc.d/init.d/functions
   
   # Source networking configuration.
   . /etc/sysconfig/network
   
   # Check that networking is up.
   [ ${NETWORKING} = "no" ] && exit 0
   [ -f /usr/sbin/sendmail ] || exit 0
   
   # See how we were called.
   case "$1" in
     start)
       # Start daemons.
       echo -n "Starting sendmail: "
       daemon /usr/sbin/sendmail -bd -q1h
       echo
       touch /var/lock/subsys/sendmail
       ;;
     stop)
       # Stop daemons.
       echo -n "Shutting down sendmail: "
       killproc sendmail
       echo
       rm -f /var/lock/subsys/sendmail
       ;;
     restart)
       $0 stop
       $0 start
       ;;
     status)
       status sendmail
       ;;
     *)
       echo "Usage: sendmail {start|stop|restart|status}"
       exit 1
     esac
    
   exit 0
   *********************************

   If you locate that file then you can rename it to something else and replace it with this content so that SIDVault is started instead of sendmail. Note that you must replace the paths in this file with the actual paths on your machine if you have not used the default SIDVault path values:

   
   Example runlevel startup script:

   *****File Content Within Stars *****
   #!/bin/sh
   #
   # Startup / shutdown script for SIDVault servers
   #
   #
   # Start or stop ?
   case "$1" in
     start)
       # start servers
       echo -n "Starting SIDVault servers: "
       echo
       /usr/local/sidvault/start.sh
       ;;
     stop)
       # stop servers
       echo -n "Stoping SIDVault servers: "
       echo
       /usr/local/sidvault/stop.sh
       ;;
     *)
     echo -n "Usage: SIDVault {start|stop}"
       echo
       exit 1
     esac
    
   exit 0
   *********************************

If you have any questions please Email:    sidvault@alphacentauri.co.nz

Nearly every SIDVault setting can be setup and changed via the managers web interface. Most SIDVault settings are stored in the sidvault.ini file on your system. This file informs the server of how it should work. In most cases the default installion will have all the settings setup for your system. Any standard text editor can be used to edited sidvault.ini, if you wish to change the file directly.

The sidvault.ini file is broken up into 8 main sections:

Once installed all the default settings will be setup to work correctly. Their will be 3 main modules setup:

Any changes done to sidvault.ini file will not take effect until the server has been reloaded or shutdown and restarted.

Now try referencing SIDVault from any web browser using a URL similar to: