Welcome to Vestris Inc.
Internet Interactive Solutions Company



Software Documentation

Installation on UNIX

Download Alkaline

Identify your operating system. Connect to your server using a telnet or an ssh session. Login as usual as a normal user. It is not necessary to have, and is not advised to use, a root access to install Alkaline. You can run the uname -a command which will produce something like:
server:~/$ uname -a
Linux ns 2.0.36 #2 Thu Nov 19 13:41:52 MET 1998 i686 unknown
        
This above operating system is obviously Linux, running on a Pentium class processor (i686).

Download an Alkaline release for your platform. Navigate to http://www.vestris.com/download/ and choose a binary distribution. You are also free to choose an Alkaline beta version, which always has the latest improvements from the live source tree.

Warning

Although we do our best to make sure that beta versions are stable and tested, they might contain debug code, produce unexpected results or behavior specific for the beta release.

Alkaline is also available via anonymous ftp from ftp://ftp.vestris.com/pub/alkaline/distrib/ .

Install and Test Binary

Gunzip and untar the downloaded distribution. Use gunzip , then tar vfx .
big-server:~/$ gunzip /tmp/asearch.1.9.Linux-x86.tar.gz 
big-server:~/$ tar vfx /tmp/asearch.1.9.Linux-x86.tar
asearch.1.9/CONTRIBUTIONS
asearch.1.9/COPYRIGHT
asearch.1.9/README
asearch.1.9/asearch.Linux
asearch.1.9/admin/ ...
big-server:~/$
big-server:~/$ ls -la
total 3
drwxr-xr-x   3 dblock   users 1024 Jun  5 08:16 ./
drwx---r-x  17 dblock   users 1024 Jun  5 08:14 ../
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:16 asearch.1.9/
big-server:~/$ 
        

Change your current directory to asearch.1.9 and test the binary, run ./asearch.OS, for example asearch.Linux on a Linux system. Use ls -la to find out the binary name.
big-server:~/asearch.1.9$ ./asearch.Linux
==================================================
Alkaline Search Engine, Version 1.9 (May 28 2000) for Linux
(c) Vestris Inc., Switzerland - 1994-2002 - All Rights Reserved
written by Daniel Doubrovkine and Hassan Sultan, University of Geneva
http://alkaline.vestris.com - dblock@vestris.com / hsultan@vestris.com
==================================================
    usage: asearch [options] port path [path2 ...]
           asearch [options] path-to-asearch.cnf command ...
     port: port to bind and listen to, ex: 9999
     path: relative path(s) to asearch.cnf files
  options: please refer to the users guide
  command: one of reindex, email, emailall, remove, rxmatch, rxrepl, etc.
_______________________________________________________________
        for more information, please refer to http://alkaline.vestris.com
big-server:~/asearch.1.9$
        
On Linux, Alkaline is statically linked, so you do not need any of the pthread shared libraries. On other UNIX flavors, Alkaline might complain about missing a library. See the troubleshooting section for more details.

Run the Demo

Alkaline is now ready for a quick demo. Run
big-server:~/asearch.1.9$ ./asearch.Linux 9999 demos/docs
==================================================
Alkaline Search Engine, Version 1.9 (May 28 2000) for Linux
(c) Vestris Inc., Switzerland - 1994-2002 - All Rights Reserved
written by Daniel Doubrovkine and Hassan Sultan, University of Geneva
http://alkaline.vestris.com - dblock@vestris.com / hsultan@vestris.com
==================================================
[checking post 1.3 configuration] {
  [verifying that (demos/docs/asearch.cnf) exists]
  [file exists (61 bytes)]
[loading global.cnf] {
  [Redirect=/admin/]
  [AdminPath=admin]
  [DocumentPath=demos/images,docs,faqs]
} loaded 31 bytes.
[warning, you should define at least a root password in global.cnf]
[Alkaline server (Apr  2 2002) running, binding to 9999]
[loading /home/asearch.1.7/demos/docs/asearch.cnf] {
  [UrlList=file:///docs/,file:///faqs]
  [Index.html=index.html]
  [RegExp][enabled for 0 element(s)]
} loaded 1 inline configuration.
[newly added to Alkaline list: Demos/docs ]
[reloading Demos/docs]
[loading indexes] {
  [no index files found (clean index)]
} done.
[indexing thread running - lazy mode]
[01:02:36 2002-04-02][building index in Demos/docs]
[01:02:56 2002-04-02][done building index in Demos/docs]
[01:02:57 2002-04-02][(re)indexing of Demos/docs processed 292 new/modified files in 0:21 min]
        

While the engine is running, navigate to http://localhost:9999/ with your web browser. The admin section of your search engine server will appear. You can select the documentation configuration under Server Parameters -> Server Configurations -> demos/docs and perform searches on it.

Create a Simple Configuration

Download the sample configuration files from http://alkaline.vestris.com/install/install-sample.tar.gz and gunzip/untar them to the installation directory.
big-server:~/asearch.1.9$ gunzip /tmp/install-sample.tar.gz
big-server:~/asearch.1.9$ tar vfx /tmp/install-sample.tar 
vestris/asearch.cnf
vestris/search.html
dicos/english.txt
big-server:~/asearch.1.9$ 
big-server:~/asearch.1.9$ ls -la
total 6
drwxr-xr-x   6 dblock   users 1024 Jun  5 08:27 ./
drwx---r-x  17 dblock   users 1024 Jun  5 08:14 ../
-rwxr-xr-x   1 dblock   users   25 Jun  5 08:20 asearch.Linux*
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 dicos/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 vestris/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 admin/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 demos/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 docs/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 faqs/
drwxr-xr-x   2 dblock   users 1024 Jun  5 08:27 tools/
-rwxr-xr-x   2 dblock   users   31 Jun  5 08:27 global.cnf
-rwxr-xr-x   2 dblock   users  720 Jun  5 08:27 CONTRIBUTIONS
-rwxr-xr-x   2 dblock   users 2107 Jun  5 08:27 COPYRIGHT
-rwxr-xr-x   2 dblock   users  419 Jun  5 08:27 README
big-server:~/asearch.1.9$
        

Use vi, joe or any other text editor such as XEmacs to modify the downloaded files as follows.

In global.cnf: if necessary, create or modify the root password; do not use your machine's administrative password
big-server:~/asearch.1.9$ cat global.cnf 
Pass root=test 
        

In vestris/asearch.cnf: modify the server you wish to index, you can try the demo with http://www.vestris.com/.
big-server:~/asearch.1.9$ cat vestris/asearch.cnf 
UrlList=http://www.vestris.com/
Remote=N
ExcludeWords=dicos/english.txt
        

In vestris/search.html: modify the server name (localhost ) by your server's IP number or server name. You can leave localhost for your local machine.
big-server:~/asearch.1.9$ cat html/search.html 
...
    <form action="http://www.big-server.com:9999/vestris/search.html" 
        method="post">
...
big-server:~/asearch.1.9$
        
Make sure that the search.html file is readable by everybody (run chmod 604 html/search.html ). This is required to make the template page accessible.

Index a Site

You can now create a first time index. Alkaline will spider the site defined in asearch.cnf following the rules of the same configuration file. This is also called a clean index. When you run Alkaline in production, it is capable of indexing in background while search is enabled.

To index the site defined by data/asearch.cnf, type ./asearch vestris reindex .
big-server:~/asearch.1.9$ ./asearch.Linux vestris reindex
======================================================
Alkaline Search Engine, Version 1.9 (Jul 18 2000) for Linux
(c) Vestris Inc., Switzerland - 1994-1999 - All Rights Reserved
written by Daniel Doubrovkine and Hassan Sultan, University of Geneva
http://alkaline.vestris.com - dblock@vestris.com / hsultan@vestris.com
======================================================
[loading /home/dblock/server-prod/t/vestris/asearch.cnf]{
  [UrlList=http://www.vestris.com/]
  [Remote=N]
  [Excludewords=dicos/english.txt]
} loaded 1 inline configuration.
[loading indexes (zero length files are ok)] {
        [vestris/siteidx1.urt][0 lines]
        [vestris/siteidx1.inf][0 lines]
        [building the md5 tree][*****]
        [vestris/siteidx1.lnx][0 lines]
        [checking cross-references, ok]
        [vestris/siteidx1.ndx][0 lines]
} done.
[parsing extensions: htm,html,shtml,txt]
[processed 0/0 resource locators]
[calculating aim [**********] - 0 indexed URLs]
[robots request for http://www.vestris.com/robots.txt][122 bytes]
[/cgi-bin/][/db-cgi/][/cgi-agnes/][/~dblock/][/alkaline/dicos/]
  [ExcludeWords][loading dicos/english.txt][35666 bytes][8937 elements]
[http://www.vestris.com/] (-1) - [1228 bytes][0]
  [inf][lnx][md5][vix][keys][mta][ndx][ok]
...
[http://www.vestris.com/sti/company.html] (-3) - [5982 bytes][294]
  [inf][lnx][md5][vix][keys][mta][ndx][ok]
        

This might take some time. You can safely interrupt Alkaline with Ctrl+C after you see
[writing databases] {
        [inf][**********]
        [lnx][**********]
        [url][**********]
        [ndx][**********]
} done.          
        

The following files will be created in the vestris directory: siteidx1.urt, siteidx1.lnx, siteidx1.ndx, siteidx1.inf.
big-server:~/asearch.1.9$ ls -la vestris/
total 205
drwxr-xr-x   2 dblock   users        1024 Jun  5 08:47 ./
drwxr-xr-x   6 dblock   users        1024 Jun  5 08:27 ../
-rwxr-xr-x   1 dblock   users         429 May 12  1999 asearch.cnf*
-rw-r--r--   1 dblock   users       38201 Jun  5 08:47 siteidx1.inf
-rw-r--r--   1 dblock   users        2205 Jun  5 08:47 siteidx1.lnx
-rw-r--r--   1 dblock   users      147102 Jun  5 08:47 siteidx1.ndx
-rw-r--r--   1 dblock   users       13592 Jun  5 08:47 siteidx1.urt
big-server:~/asearch.1.9$ 
        

Search Your Index

Run the Alkaline server daemon. It is up to you to detach or not the process by using the Unix & on the command line.
big-server:~/asearch.1.9$ ./asearch 9999 vestris
=====================================================
Alkaline Search Engine, Version 1.9 (May 28 2000) for Linux
(c) Vestris Inc., Switzerland - 1994-1999 - All Rights Reserved
written by Daniel Doubrovkine and Hassan Sultan, University of Geneva
http://alkaline.vestris.com - dblock@vestris.com / hsultan@vestris.com
=====================================================
[checking post 1.3 configuration] {
        [verifying that (vestris/asearch.cnf) exists]
        [file exists (77 bytes)]
[surveillance thread running]
[(re)reading global.cnf]{
  [setting password for {root}]
} loaded 15 bytes.
Alkaline server (Jul 18 2000) running.
[loading /home/dblock/server-prod/t/vestris/asearch.cnf]{
  [UrlList=http://www.vestris.com/]
  [Remote=N]
  [Excludewords=dicos/english.txt]
} loaded 1 inline configuration.
[newly added to Alkaline list: vestris ]
[reloading vestris]
[loading indexes (zero length files are ok)] {
        [vestris/siteidx1.urt][1234 lines]
        [vestris/siteidx1.inf][1234 lines]
        [building the md5 tree][*****]
        [vestris/siteidx1.lnx][1234 lines]
        [checking cross-references, ok]
        [vestris/siteidx1.ndx][45678 lines]
} done.
[indexing thread running - lazy mode]
[parsing extensions: htm,html,shtml,txt]
        
This will run Alkaline in a so called lazy mode, responding to requests on port 9999 and indexing your site again and again in background.

Try to connect to the administrative pages. Navigate to http://www.your-server:9999/ and login using the username root and the password you have entered in global.cnf above.

Now try to search. Open the search.html page using a normal browser such as MS Internet Explorer or Netscape Navigator, and try to search something - you should get immediate results.

You can also try to navigate to the following URL: http://www.your-server:9999/vestris/search.html?search=test directly.

Stopping Alkaline

It is safe to terminate Alkaline with a Ctrl-C if it is running in a non-detached mode. You can stop Alkaline from the online management console. Also, the Alkaline tools set contains a perl script, AlkalineStop.pl. Alternatively, to terminate Alkaline, you can kill all Alkaline processes. You can use a variant of: ps ex | grep asearch | cut -b-6 | sort -rn | xargs -l kill -9 .