Skip to main content

A squid cache publishing and advertising tool designed to work in fast changing environments

Project description

Shoal Agent README

Version: v1.0.1

Important to know about the configuration

The configuration has been simplified compared to previous versions and most settings are automatically configured at runtime. There is also a setup script which should be run right after the pip install which will help to set the right options for the shoal-agent. The config file is placed in /etc/shoal/shoal_agent.conf by the setup script and can be edited manually later on too. The new shoal-agent is compatible with python3 as well as python2. It is recommended to use the python3 version.

Included in frontier-squid, used by WLCG

The frontier-squid rpm distribution of squid (provided by the Worldwide LHC Computing Grid, WLCG) includes shoal-agent which can be enabled in its configuration. It uses the same default shoal server. The WLCG also includes shoal-tracked squids in its Web Proxy Auto Discovery service (see above configuration link).

Basic Commands

With the basic shoal_agent init script you can do the following:

service shoal-agent start
service shoal-agent stop
service shoal-agent restart


The recommended way to install is with pip. Although, the Shoal agent does not require root privilege to run; by default the shoal user and group is used; it should be installed as root. If the shoal user and group do not exist then the install script will create the entries in the system.

Note: Requires you have Python 3.6+, and the pika, netifaces python module (available from EPEL).

Recommended Method: Use pip (est. ~5 min)

  1. Login as root or become root via sudo su -
  2. Install shoal-agent using pip/pip3, e.g. pip3 install shoal-agent
  3. Run the installation script,, to setup your configuration

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shoal-agent-1.0.2.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

shoal_agent-1.0.2-py3-none-any.whl (15.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page