shoal-agent

v1.0.2

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

44 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Popularity

Limited

GitHub Stars: 4
Forks: 8
Contributors: 20

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 3, 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-agent 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

No Recent Commits

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

Further analysis of the maintenance status of shoal-agent 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-agent 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-agent 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-agent 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: 4 Direct / 8 Total
Versions: 23
Maintainers: 3
Wheels: OS Independent

Readme

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

Installation

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)

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

shoal-agent dependencies

netifaces pika pystun3 requests

FAQs

What is shoal-agent?

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-agent, including popularity, security, maintenance & community analysis.

Is shoal-agent popular?

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

Is shoal-agent well maintained?

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

Is shoal-agent safe to use?

While scanning the latest version of shoal-agent, 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 19 November-2024, at 23:57 (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