Skip to content

Gungnir - Homelab Automation Tool to Guard your very own Asgard

License

Notifications You must be signed in to change notification settings

GeekMasher/gungnir

Repository files navigation

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