From b14e7d5d59a0a5f1ab4fb42f1010dcdf52059198 Mon Sep 17 00:00:00 2001 From: Max Harley Date: Fri, 22 Mar 2024 21:05:54 +0100 Subject: [PATCH] Update documentation for new GH pages repo --- docs/requirements.md | 12 ++++++++++-- docs/setup.md | 9 ++++++++- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/requirements.md b/docs/requirements.md index 4eb2576..379db44 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -75,9 +75,17 @@ helm repo add bitnami https://charts.bitnami.com/bitnami 6. Start Nemesis Quickstart - This create secrets that are nessecary for Nemesis to run. If you want to edit any of the password values for Nemesis, edit them in [values.yaml](../helm/quickstart/values.yaml). + This create secrets that are nessecary for Nemesis to run. - Run `helm install nemesis-quickstart ./helm/quickstart` to kick off the quickstart. + Run `helm install --repo https://specterops.github.io/Nemesis/ nemesis-quickstart quickstart` + + If you want to edit any of the password values for Nemesis, edit them in [values.yaml](../helm/quickstart/values.yaml). + + ``` + curl https://raw.githubusercontent.com/SpecterOps/Nemesis/helm/helm/quickstart/values.yaml -o quickstart-values.yaml + # Edit values.yaml as you need + helm install --repo https://specterops.github.io/Nemesis/ nemesis-quickstart quickstart -f quickstart-values.yaml + ``` 7. Install Nginx Ingress and eck-operator diff --git a/docs/setup.md b/docs/setup.md index 6b93150..5dafa78 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,7 +1,14 @@ # Nemesis Installation and Setup 1. Ensure the [requisite software/hardware is installed](./requirements.md). -2. Run `helm install nemesis ./helm/nemesis --timeout '45m'` to kick off the Nemesis install. Optionally configure build values in [values.yaml](../helm/nemesis/values.yaml) for things like resource requests/etc. +2. Run `helm install https://specterops.github.io/Nemesis/ nemesis nemesis --timeout '45m'` to kick off the Nemesis install. Optionally configure build values in [values.yaml](../helm/nemesis/values.yaml) for things like resource requests/etc. + + To configure [values.yaml](../helm/nemesis/values.yaml), download values.yaml and install using helm. + + ```bash + curl https://raw.githubusercontent.com/SpecterOps/Nemesis/helm/helm/nemesis/values.yaml -o nemesis-values.yaml + helm install https://specterops.github.io/Nemesis/ nemesis nemesis --timeout '45m' -f nemesis-values.yaml + ``` If you want monitoring capabilities, run `helm install nemesis-monitoring ./helm/monitoring`