c-icap(8) System Manager's Manual c-icap(8)
NAME
c-icap - ICAP filtering server
SYNOPSIS
c-icap [ -f config-file ] [ -N ] [ -d debug-level ] [ -D ]
DESCRIPTION
c-icap is an implementation of an ICAP server. It can be used with HTTP proxies that support the ICAP protocol. Most of the comercial HTTP
proxies must support ICAP pcotocol.
OPTIONS
-f config-file
Specify the configuration file
-N Do not run as daemon
-d level
Specify the debug level
-D Print debug info to stdout
FILES
/etc/c-icap/c-icap.conf
The main configuration file
/etc/c-icap/c-icap.magic
In this file defined the types of files and the groups of file types.
/var/run/c-icap.pid
By default c-icap writes its pid in this file. The path of this file can changed using the PidFile configuration parameter in the c-
icap.conf file
/var/run/c-icap.ctl
The commands socket. This file used to send commands to the icap server from command line. For information about implemented com-
mands look below in the "Implemented commands" sub-section
NOTES
Implemented commands
Currently the following commands are implemented:
stop
The c-icap will shutdown
reconfigure
The service will reread the config file without the need to stop and restart the c-icap server. The services will be reinitialized
Services and modules can define their own commands.
Examples:
To reconfigure c-icap:
echo -n "reconfigure" > /var/run/c-icap.ctl
Lookup tables
Lookup tables are simple read-only databases. A lookup table can defined in c-icap.conf file using the form:
type:path
where the type is the type of lookup table and path is the extra information required to use the table (e.g. file path). Currently the fol-
lowing lookup table types defined internally by c-icap:
file Simple text file databases. The database records are stored in text files in the form:
key[: value1, value2 ...]
example path definition:
file:/path/to/the/file.txt
hash Similar to file lookup tables but c-icap uses fast hashes for searching.
example path definition:
hash:/path/to/the/file.txt
regex Similar to the file lookup tables but the keys are regular expressions in the form /regex/flags where flags are 'i' to ignore case
or nothing.
example regex lookup table data:
/^[a-m].*/i: group1
/^[n-z].*/i: group2
example path definition:
regex:/path/to/the/file.txt
Runtime information
Someone can retrieve runtime information using the info service. The information includes bytes received and transmited, active services,
information about service usage and many other. The information provided in HTML and text format.
Example:
Retrieve runtime information from command line:
c-icap-client -i localhost -s "info?view=text" -req "a_url"
SEE ALSO
c-icap-client(8) c-icap-stretch(8) c-icap-config(8) c-icap-libicapapi-config(8) c-icap-mkbdb(8)
BUGS
Many...
AUTHOR
Tsantilas Christos
c_icap 0.1.6 c-icap(8)