https://github.com/bketelsen/inventory
Inventory is an application that tracks deployed services/containers. It was built with a homelab in mind.
https://github.com/bketelsen/inventory
docker homelab incus
Last synced: 7 months ago
JSON representation
Inventory is an application that tracks deployed services/containers. It was built with a homelab in mind.
- Host: GitHub
- URL: https://github.com/bketelsen/inventory
- Owner: bketelsen
- License: mit
- Created: 2025-03-04T18:48:27.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-04T20:18:30.000Z (8 months ago)
- Last Synced: 2025-03-04T20:18:42.879Z (8 months ago)
- Topics: docker, homelab, incus
- Language: CSS
- Homepage:
- Size: 489 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inventory
Inventory is an application that tracks deployed services/containers. It was built with a homelab in mind. It aims to answer the question:
| "Where the heck did I deploy Jellyfin, and was it Docker or Incus?"
## Installation
Put the binary somewhere you can find it. `/usr/local/bin/` never hurts.
Example systemd unit files are in the `/contrib` folder, along with example crontab and logrotate configurations.
## Configuration
`inventory` searches `/etc/inventory/` and `$HOME/.inventory` for a yaml formatted file named `inventory` with configuration values.
Currently, you can set log level to verbose, and specify the server where reports are sent.
Example config:
```yaml
server:
address: "10.0.1.5:9999"
verbose: false
```
If you want to track services that aren't deployed via docker or incus, you can add them as an array to the config file like this:
```yaml
services:
- name: syncthing
port: 8384
listenaddress: 10.0.1.15
protocol: tcp
unit: syncthing@.service
```
## Permissions
The `inventory send` command should be run by a user who belongs to the `docker` and `incus-admin` groups. This can be root,
or any other user in those groups.
## Web Template
Web template modified from [AdminLTE](https://github.com/ColorlibHQ/AdminLTE), MIT License, Copyright (c) 2014-2023 ColorlibHQ