procustodibus-agent 1.6.1

Last updated:

0 purchases

procustodibus-agent 1.6.1 Image
procustodibus-agent 1.6.1 Images
Add to Cart

Description:

procustodibusagent 1.6.1

Pro Custodibus Agent
Pro Custodibus is a service that makes WireGuard networks easy to deploy and manage. You run the Pro Custodibus agent on each WireGuard host you want to manage, and the agent monitors and synchronizes the hosts' WireGuard settings with the remote Pro Custodibus service.
Installing
Requires python 3.8 or newer and libsodium. Installer script can install requirements, plus the agent itself, on most linuxes, FreeBSD, OpenBSD, and macOS (if macOS has Homebrew). Install from source like the following:
./install.sh --install

Or run it like the following to see more options:
./install.sh --help

See the Installer Documentation for full details (or to download the pre-built Windows installer).
Docker
The docker/wireguard.dockerfile is built weekly and pushed to the docker.io/procustodibus/wireguard repository. It produces a base WireGuard image without the agent.
The docker/agent.dockerfile is built weekly and pushed to the docker.io/procustodibus/agent repository. It produces a Docker image with WireGuard and the latest agent installed together.
Run either image by placing your WireGuard or Pro Custodibus configuration files in a host directory like /srv/containers/wireguard/conf, and then running the image like the following:
docker run \
--cap-add NET_ADMIN \
--publish 51820:51820/udp \
--name wireguard \
--rm \
--volume /srv/containers/wireguard/conf:/etc/wireguard \
procustodibus/agent

See the Container Documentation for full details.
Development
Set up dev env


Create a virtualenv with pyenv:
pyenv virtualenv 3.10.4 procustodibus-agent



Activate the virtualenv:
pyenv local procustodibus-agent 3.8.19 3.9.19 3.10.14 3.11.9 3.12.4



Install tox:
pip install tox



Install pre-commit and pre-push hooks:
tox -e pre-commit -- install
tox -e pre-commit -- install -t pre-push



Dev tasks
List all tox tasks you can run:
tox -av

Run unit tests in watch mode:
tox -e watch

Build and run docker dev image (with *.conf files in /srv/containers/wireguard/conf):
tox -e build
docker/dev.sh dev
docker run \
--cap-add NET_ADMIN \
--publish 51820:51820/udp \
--name wireguard \
--rm \
--volume /srv/containers/wireguard/conf:/etc/wireguard \
procustodibus-agent:dev

Run all (docker-based) installer tests:
docker-compose -f test_install/docker-compose.yml build --pull
tox -e py310 -- test_install

Manually run pre-push hook on all version-controlled files:
tox -e pre-commit -- run -a --hook-stage push

Build Windows installer


Install Python.


Install Inno Setup.


Create a virtualenv:
python -m venv C:\venvs\procustodibus-agent



Activate the virtualenv:
C:\venvs\procustodibus-agent\Scripts\activate.bat



Install tox:
pip install tox



Build the Windows executables with cx_freeze:
tox -e build_exe



Build the Windows installer with Inno Setup:
"C:\Program Files (x86)\Inno Setup 6\ISCC.exe" installer\windows.iss



The installer will be built as dist\ProCustodibusAgentInstaller.exe.
Contributing

Code of Conduct
File a Bug
Report a Vulnerability
Submit a Patch

Resources

Home page: https://www.procustodibus.com/
Documentation: https://docs.procustodibus.com/guide/agents/run/
Changelog: https://docs.procustodibus.com/guide/agents/download/#changelog
Issue tracker: https://todo.sr.ht/~arx10/procustodibus
Mailing list: https://lists.sr.ht/~arx10/procustodibus
Source code: https://git.sr.ht/~arx10/procustodibus-agent

License
The MIT License

License:

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Customer Reviews

There are no reviews.