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