Skip to main content

Homelab Automation Bot to Guard your very own Asgard

Project description

gungnir

GitHub GitHub Actions GitHub Issues GitHub Stars Python Versions Licence

Overview

Gungnir is a Homelab Automation Bot to Guard your very own Asgard from the dangerous world of out of date components.

Example

DependencyTrack Example

Usage

CLI

Requirements:

  • Python 3.9+
  • Syft (generate bill of materials)

Install (pip):

pip install gungnir

Help:

python -m gungnir --help
Gungnir - Homelab Automation Tool to Guard your very own Asgard

options:
  -h, --help            show this help message and exit
  --debug               Enable Debug mode
  --banner              Show banner
  --version             Show version
  --container           Enable container mode
  --disable-banner      Disable banner
  --hostname HOSTNAME   Hostname (mainly for containers)

DependencyTrack:
  -t TOKEN, --token TOKEN
                        DependencyTrack Token
  -i INSTANCE, --instance INSTANCE
                        DependencyTrack Instance

Docker-Compose

Download the docker-compose.yml example and run with the following command:

docker-compose up

Environment Variable:

DEPENDENCYTRACK_URL=http://localhost:9090
DEPENDENCYTRACK_TOKEN=ABCD...

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Support

Please create issues for any feature requests, bugs, or documentation problems.

Acknowledgement

  • @GeekMasher - Author and Maintainer

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

gungnir-0.3.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

gungnir-0.3.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file gungnir-0.3.0.tar.gz.

File metadata

  • Download URL: gungnir-0.3.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for gungnir-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e7510de1cea0b05eaf9de0db1e799b69371c8bd5cccd8c65d69688642c43c570
MD5 5605dc2bf19fcedaaf548c912c614734
BLAKE2b-256 87044b3706616dd91bcd5563ffbaaed7cfe14687782917cf9b83ee4fe2a45259

See more details on using hashes here.

File details

Details for the file gungnir-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: gungnir-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for gungnir-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39a253dd2c8a7529840b5306e909e8b4f18004ebddcf6fe01fd842712370a2c7
MD5 83f5c212f88e82babbe85abd57084043
BLAKE2b-256 c2051e10822cc00a28fcead6edb1126dcdceb91d3acf2b3b944ed88a20069ff1

See more details on using hashes here.

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