add a README file, prompted by a mail from Kaya Saman

This commit is contained in:
sthen 2013-11-06 13:07:43 +00:00
parent 7b70e464d5
commit dcef5fa7e9
3 changed files with 45 additions and 3 deletions

View File

@ -1,11 +1,11 @@
# $OpenBSD: Makefile,v 1.3 2013/11/05 15:05:32 sthen Exp $
# $OpenBSD: Makefile,v 1.4 2013/11/06 13:07:43 sthen Exp $
SHARED_ONLY= Yes
COMMENT= clamd-based virus scanner for c-icap
DISTNAME= squidclamav-6.10
REVISION= 1
REVISION= 2
CATEGORIES= www

View File

@ -1,4 +1,5 @@
@comment $OpenBSD: PLIST,v 1.1.1.1 2013/04/16 10:00:46 sthen Exp $
@comment $OpenBSD: PLIST,v 1.2 2013/11/06 13:07:43 sthen Exp $
@comment lib/c_icap/squidclamav.a
lib/c_icap/squidclamav.so
libexec/squidclamav/
libexec/squidclamav/clwarn.cgi
@ -8,6 +9,7 @@ libexec/squidclamav/clwarn.cgi.fr_FR
libexec/squidclamav/clwarn.cgi.pt_BR
libexec/squidclamav/clwarn.cgi.ru_RU
@man man/man1/squidclamav.1
share/doc/pkg-readmes/${FULLPKGNAME}
share/doc/squidclamav/
share/doc/squidclamav/README
share/examples/squidclamav/

View File

@ -0,0 +1,40 @@
$OpenBSD: README,v 1.1 2013/11/06 13:07:43 sthen Exp $
+-----------------------------------------------------------------------
| Running ${FULLPKGNAME} on OpenBSD
+-----------------------------------------------------------------------
squidclamav is not a standalone daemon, it is a module to use with the
c-icap service container.
To enable it, edit ${SYSCONFDIR}/c-icap/c-icap.conf and add this line:
Service squidclamav squidclamav.so
Review the other settings in c-icap's configuration file and
${SYSCONFDIR}/squidclamav.conf and make any changes needed (in particular
check the clamd socket location matches clamd's configuration).
When happy, start c-icap (and add to "pkg_scripts" in rc.conf.local(5)
if wanted):
/etc/rc.d/c_icap start
To make use of this from Squid, your configuration should have lines
like this (adapted from http://squidclamav.darold.net/installv6.html):
icap_enable on
icap_send_client_ip on
icap_send_client_username on
icap_client_username_encode off
icap_client_username_header X-Authenticated-User
icap_preview_enable on
icap_preview_size 1024
icap_service service_req reqmod_precache bypass=1 \
icap://127.0.0.1:1344/squidclamav
adaptation_access service_req allow all
icap_service service_resp respmod_precache bypass=1 \
icap://127.0.0.1:1344/squidclamav
adaptation_access service_resp allow all
The "icap_service" lines are split for this README, but should be
entered on one line.