Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geekmasher/gungnir

Gungnir - Homelab Automation Tool to Guard your very own Asgard
https://github.com/geekmasher/gungnir

Last synced: 5 days ago
JSON representation

Gungnir - Homelab Automation Tool to Guard your very own Asgard

Host: GitHub
URL: https://github.com/geekmasher/gungnir
Owner: GeekMasher
License: mit
Created: 2023-06-21T18:59:40.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-16T19:02:56.000Z (21 days ago)
Last Synced: 2024-10-25T04:06:29.797Z (12 days ago)
Language: Python
Homepage: https://pypi.org/project/gungnir/
Size: 334 KB
Stars: 14
Watchers: 2
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # gungnir



[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GeekMasher/gungnir)

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/geekmasher/gungnir/python-package.yml?style=for-the-badge)](https://github.com/GeekMasher/gungnir/actions/workflows/python-package.yml?query=branch%3Amain)

[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/gungnir?style=for-the-badge)](https://github.com/GeekMasher/gungnir/issues)

[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/gungnir?style=for-the-badge)](https://github.com/GeekMasher/gungnir)

[![Python Versions](https://img.shields.io/pypi/pyversions/gungnir?style=for-the-badge)](https://pypi.org/project/gungnir/)

[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)



## 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](./assets/dependency-track-example.png)

## Usage

### CLI

**Requirements:**

- Python 3.9+

- [Syft](https://github.com/anchore/syft) (generate bill of materials)

**Install (pip):**

```bash

pip install gungnir

```

**Help:**

```bash

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](./docker-compose.yml) and run with the following command:

```bash

docker-compose up

```

**Environment Variable:**

```env

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](./LICENSE) for the full terms.

## Support

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

## Acknowledgement

- @GeekMasher - Author and Maintainer