shoal-client

v1.0.4

A squid cache publishing and advertising tool designed to work in fast changing environments For more information about how to use this package see README

Latest version published 1 year ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

47 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Popularity

Small

GitHub Stars: 4
Forks: 8
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package shoal-client, we found that it has been starred 4 times.

Security

Security review needed

Security and license risk for latest version

Release Date: May 31, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like shoal-client is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 19
Open PR: 0
Last Release: 1 year ago
Last Commit: 11 months ago

Further analysis of the maintenance status of shoal-client based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for shoal-client is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the shoal-client repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like shoal-client is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: Unspecified

Age: 12 years
Latest Release: 1 year ago
Dependencies: N/A
Versions: 17
Maintainers: 3
Wheels: No

Readme

Shoal Client README

shoal-client will configure cvmfs to use the closest squid server to you by contacting the shoal server and using cvmfs-talk to update the active proxy configuration.

shoal-client is a simple python script typically configured to run with cron to check for new squids periodically. Before setting the cronjob in place make sure that shoal-client is configured correctly (see Usage below).

With the release of v0.6.4 the shoal-client now offers support for frontier. Running the shoal-client with the --frontier or -f option will produce an output string instead of attempting to update the proxies via cvmfs-talk. See Usage below for more information.

Installation

Note: Requires Python 2.4+

Note: Shoal config files will be located either at ~/.shoal/ or /etc/shoal/ if installed root permissions.

Recommended Instalation Method: Use pip

sudo python3 -m pip install shoal-client or, if using an old python2 version of pip: pip install shoal-client

Copy the configuration file to proper location

# For python3
cp /usr/local/share/shoal-client/shoal_client.conf /etc/shoal/

# For python2
cp /usr/share/shoal-client/shoal_client.conf /etc/shoal/

Check settings in shoal_client.conf update as needed

Usage

Confirm the that you configured shoal-client as expected by checking the output of shoal-client --dump The output is a list of servers that will be set as proxies using cvmfs-talk. For example you will see something like the following:

http://squid.example1.com:3128;http://squid.example2.com:3128;http://squid.example3.com:3128;http://squid.example4.com:3128;http://squid.example5.org:3128;DIRECT

If the output looks resonable now set a crontab entry to run shoal say every 30 minutes:

0,30 * * * * /usr/bin/shoal-client

New in version 0.6.4 is the --frontier option that will produce an output string suitable for frontier. Users will need to use a simple script that runs shoal-client and uses the output to set the proxies. An example script can be found here in the shoal-client/scripts directory. Example output when running shoal-client --frontier:

(serverurl=http://PresetServer.ca:3128)(proxyurl=http://PROXY.FROM.SHOAL.1:3128)(proxyurl=http://PROXY.FROM.SHOAL.2:3128)

Flags and Options

Option	Description
-d or --dump	Print closest proxies to terminal for testing or debugging.
-s `hostname` or --server `hostname`	Specifies URL of the desired shoal-server to contact. Takes precedence over the option in config file.
-n `int` or --squids `int`	Specifies the number of squids to retrieve from the shoal-server.
-f or --frontier	Outputs a string appropriate for use as the frontier proxy enviroment variable instead of using cvmfs-talk to update the active proxy configuration.
-k or --skip-broadcast	Skips waiting to hear from a shoal-agent on the local network and goes directly to the shoal server for a squid. Only reccomended when you know there is no squid//agent on the local network.

Shoal client now uses the cvmfs_talk protocol. To view the list of returned squids issue:

 cvmfs_talk proxy info

Other Installation Methods

Using Pip

pip install shoal-client

Copy the configuration file to proper location

# For python3
cp /usr/local/share/shoal-client/shoal_client.conf /etc/shoal/

# For python2
cp /usr/share/shoal-client/shoal_client.conf /etc/shoal/

Check settings in shoal_client.conf update as needed

Using Git

git clone git://github.com/hep-gc/shoal.git
cd shoal/shoal-client/
python setup.py install
Copy the configuration file to proper location cp conf/shoal_client.conf /etc/shoal/
Check settings in shoal_client.conf update as needed

FAQs

What is shoal-client?

A squid cache publishing and advertising tool designed to work in fast changing environments. Visit Snyk Advisor to see a full health score report for shoal-client, including popularity, security, maintenance & community analysis.

Is shoal-client popular?

The python package shoal-client receives a total of 1,740 weekly downloads. As such, shoal-client popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is shoal-client well maintained?

We found indications that shoal-client is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is shoal-client safe to use?

While scanning the latest version of shoal-client, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 7 November-2024, at 22:06 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP