view release on metacpan or  search on metacpan

bin/elsquid  view on Meta::CPAN

Generate new squidguard database files for more performance.

=item B<--permissions>

Fix permissions/ownership (files must belong to proxy user).

=item B<--reload>

Reload squid.

=item B<--squidguardconf>

Dump suggested configuration snippets for Squid and SquidGuard.

=item B<--exampleconf>

Create an example F</etc/elsquid.conf> (unless there is already one present).

=item B<--help>

Print this page.

=back


=head1 CONFIGURATION FILE

B<elsquid>'s configuration file is F</etc/elsquid.conf>.

Please create an example as a starting point with B<--exampleconf>
if you don't already have one.

The syntax is INI-style. It uses the following sections/directives:


=head2 Section C<[squidguard]>

=over 4

=item C<dbhome>

Root of SquidGuards database hierarchy. Defaults to
F</var/lib/squidguard/db>.

B<elsquid> will put the generated files here, with the following hierarchy:

  elsquid
  |-- black
  |   |-- domains
  |   |-- expressions
  |   `-- urls
  `-- white
      |-- domains
      |-- expressions
      `-- urls


=item C<user>, C<group>

User and group of the Squid process. Used for chmod'ing the generated files.
Defaults to C<proxy>/C<proxy>.

=item C<executable>

Full path to the squidGuard executable. Defaults to C</usr/bin/squidGuard>.

=item C<redirect_url>

Redirect URL that is returned by squidGuard in case of blocking.
This is only needed to dump an example config snippet.
Defaults to C<http://192.168.1.2/blank.gif>, which is probably not what you
want :-)

=back

=head2 Section C<[squid]>

=over 4

=item C<reload_cmd>

The command needed to reload the Squid service.
Defaults to C<systemctl reload squid3>.

=item C<dstdomain_blacklist>

B<elsquid> also writes the domain blacklist into this file. This is intended
for direct use with a Squid acl to get better results when blocking
HTTPS-requests.

Defaults to F</etc/squid3/elsquid-black.txt>.

=item C<dstdomain_whitelist>

Analogous to C<dstdomain_blacklist>.

Defaults to F</etc/squid3/elsquid-white.txt>.


=back

=head2 Section C<[easylists]>

=over 4

=item C<download_dir>

Directory where the downloaded files go to. Defaults to C</tmp>.

=item C<list_url>

URL of an easylist to use. Can be repeated. No default here.

I personally use:

=over 4

=item C<list_url = https://easylist-downloads.adblockplus.org/easylist.txt>

=item C<list_url = https://easylist-downloads.adblockplus.org/easylistgermany.txt>