Skip to content

docs: add helm/kubernetes install instructions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lmacka wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add helm/kubernetes install instructions #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
[![Dependencies](https://img.shields.io/badge/dependencies-1%20(express)-orange)](#architecture)
[![Sources](https://img.shields.io/badge/OSINT%20sources-27-cyan)](#data-sources-27)
[![Docker](https://img.shields.io/badge/docker-ready-blue?logo=docker)](#docker)
[![Helm Chart](https://img.shields.io/badge/helm%20chart-0.2.0-blue?logo=helm)](https://artifacthub.io/packages/helm/helm-crucix/crucix)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/helm-crucix)](https://artifacthub.io/packages/helm/helm-crucix/crucix)

![Crucix Dashboard](docs/dashboard.png)

Expand Down Expand Up @@ -93,6 +95,16 @@ docker compose up -d

Dashboard at `http://localhost:3117`. Sweep data persists in `./runs/` via volume mount. Includes a health check endpoint.

### Kubernetes (Helm)

```bash
helm repo add crucix https://lmacka.github.io/helm-crucix/
helm repo update
helm install crucix crucix/crucix -n crucix --create-namespace
```

Dashboard at `http://<service-ip>`. Configure API keys via `extraEnv` or a Secret with `extraEnvFrom`. Persistent storage for sweep memory is enabled by default. See the [Helm chart repo](https://github.com/lmacka/helm-crucix) for full values documentation.

---

## What You Get
Expand Down