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.2.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gungnir-0.2.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for gungnir-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d890d2a5813f635edb2cb1966d8e4656f6bfeb9a0ec3d6d6094c00052f24428f
MD5 ec39f30cbe17d950a3c9ae1b28f1a334
BLAKE2b-256 798a70d64e3b96013d416e861965ee91e02744bd2e1e94e28d83010b781b01dc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gungnir-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6b3d5dd1f064696839db5404be18c1879be0120a58aa5a32b82572e2c082ff1
MD5 cda0477b199d10c67854bb7d3f968927
BLAKE2b-256 85e43f0cf9f526dbfebef1e9af8a7edd5487e62aadbd85b82ce9cc6770dadd83

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