INSTALL
changeset 8 8d0f25ef038e
child 11 9aa5114326e8
equal deleted inserted replaced
7:e4f1a551d45c 8:8d0f25ef038e
       
     1 
       
     2 Building volta
       
     3 ===============
       
     4 
       
     5 Volta should build with minimal effort.  First, make sure you have
       
     6 dependencies installed.
       
     7 
       
     8 
       
     9 Dependencies
       
    10 ------------
       
    11 
       
    12 Currently, volta requires the following to compile:
       
    13 
       
    14 Regular dependencies:
       
    15 
       
    16   - GNU make (http://www.gnu.org/software/make/)
       
    17   - sqlite3 (http://www.sqlite.org/)
       
    18 
       
    19 Development dependencies (optional):
       
    20 
       
    21   - ragel (http://www.complang.org/ragel/)
       
    22   - mercurial (http://mercurial.selenic.com/)
       
    23   - google-perftools (http://code.google.com/p/google-perftools/)
       
    24   - graphviz (http://www.graphviz.org/)
       
    25   - ctags (http://ctags.sourceforge.net/)
       
    26 
       
    27 
       
    28 Compiling
       
    29 ---------
       
    30 
       
    31 Just type 'make'.  Depending on your platform, GNU make may have been
       
    32 installed as 'gmake' If you get any errors, try 'gmake' first.
       
    33 
       
    34 It should build without warnings.
       
    35 
       
    36 
       
    37 Installation
       
    38 ------------
       
    39 
       
    40 Volta doesn't contain any installation targets.  You can put the binary
       
    41 wherever makes sense on your system.  Note that it should be in a
       
    42 directory that is writable to Squid, unless you plan to store the
       
    43 database separately.  An example:
       
    44 
       
    45 	mv volta /usr/local/bin
       
    46 	mkdir -p /var/db/squid
       
    47 	chown squid:squid /var/db/squid
       
    48 	volta -f /var/db/squid/volta.db
       
    49 
       
    50 I usually just drop it into the squid configuration directory and run it
       
    51 from there.
       
    52 
       
    53 For usage information, see the README.
       
    54 
       
    55 
       
    56 Development
       
    57 -----------
       
    58 
       
    59 Volta source can be cloned via Mercurial.  The repo is found at:
       
    60 
       
    61 	http://code.martini.nu/volta
       
    62 
       
    63 You can use the 'debug' make target to compile a (very noisy) binary
       
    64 that contains gdb symbols and perftool hooks.  Set the CPUPROFILE
       
    65 environment variable to "cpu.prof" to generate a profile.
       
    66