diff --git a/docs/assets/images/screenshots/matrix-networking.png b/docs/assets/images/screenshots/matrix-networking.png new file mode 100644 index 000000000..85cc101e3 Binary files /dev/null and b/docs/assets/images/screenshots/matrix-networking.png differ diff --git a/docs/assets/images/screenshots/matrix-web-app.png b/docs/assets/images/screenshots/matrix-web-app.png new file mode 100644 index 000000000..e3f5ad0c8 Binary files /dev/null and b/docs/assets/images/screenshots/matrix-web-app.png differ diff --git a/docs/assets/images/screenshots/matrix.png b/docs/assets/images/screenshots/matrix.png new file mode 100644 index 000000000..3f64d2516 Binary files /dev/null and b/docs/assets/images/screenshots/matrix.png differ diff --git a/docs/assets/images/screenshots/matrix_screenshot.png b/docs/assets/images/screenshots/matrix_screenshot.png deleted file mode 100644 index 09703d3e8..000000000 Binary files a/docs/assets/images/screenshots/matrix_screenshot.png and /dev/null differ diff --git a/docs/k8s_apps/matrix.md b/docs/k8s_apps/matrix.md index b8d7cf15f..b6e4c9442 100644 --- a/docs/k8s_apps/matrix.md +++ b/docs/k8s_apps/matrix.md @@ -2,10 +2,28 @@ `smol-k8s-lab` deploys a matrix synapse server, element (a web frontend), and a turn server (voice server). - -screenshot of the Argo CD web interface showing the matrix app of apps in tree view mode, which shows the following children: persistence app, external secrets appset, postgres appset, s3 provider appset, s3 pvc app set, and matrix web app set. + +screenshot of the Argo CD web interface showing the matrix app of apps in tree view mode, which shows the following children: external secrets appset, postgres appset, matrix PVC appset, s3 provider appset, s3 pvc app set, and matrix web app set. +
+ Matrix helm chart app in Argo CD + + + screenshot of the Argo CD web interface showing the matrix web app in tree view mode. + + +
+ +
+ Matrix networking view in Argo CD + + + screenshot of the Argo CD web interface showing the matrix web app in tree view mode. + + +
+ The main variable you need to worry about when setting up matrix is your `hostname`. ## Sensitive values diff --git a/docs/k8s_apps/nextcloud.md b/docs/k8s_apps/nextcloud.md index 5236dfe6e..4cc659c19 100644 --- a/docs/k8s_apps/nextcloud.md +++ b/docs/k8s_apps/nextcloud.md @@ -1,14 +1,17 @@ [Nextcloud](https://nextcloud.com/) is an Open Source and self hosted personal cloud which acts as a replacement for Google Drive/Google Photos/iCloud Drive. We can deploy it for you as a featured Argo CD app ([small-hack/argocd-apps/nextcloud](https://github.com/small-hack/argocd-apps/tree/main/nextcloud)) on Kubernetes. Here's an example of the full nextcloud app of apps in Argo CD's web interface: -screenshot of the Argo CD web interface showing the nextcloud app of apps in tree view mode, which shows the following child apps: before starting scripts, external secrets appset, maintenance mode cron appset, postgres appset, nextcloud PVC appset, s3 provider appset, s3 pvc app set, nextcloud web app set, and install nexcloud apps post install hook job. Each of these appsets then deploys a similar named app and the job deploys a pod of the same name. + screenshot of the Argo CD web interface showing the nextcloud app of apps in tree view mode, which shows the following child apps: before starting scripts, external secrets appset, maintenance mode cron appset, postgres appset, nextcloud PVC appset, s3 provider appset, s3 pvc app set, nextcloud web app set, and install nexcloud apps post install hook job. Each of these appsets then deploys a similar named app and the job deploys a pod of the same name. -Here's the actual nextcloud helm chart app in Argo CD: +
+ Nextcloud Argo CD helm chart app - -screenshot of the Argo CD web interface showing the nextcloud-web-app helm chart app and all of its resources in tree view mode. - + + screenshot of the Argo CD web interface showing the nextcloud-web-app helm chart app and all of its resources in tree view mode. + + +
Part of the `smol-k8s-lab` init process is that we will put the following into your Bitwarden vault: diff --git a/docs/tui/help_screen.md b/docs/tui/help_screen.md index 034e11ddc..e2530cc60 100644 --- a/docs/tui/help_screen.md +++ b/docs/tui/help_screen.md @@ -1,6 +1,6 @@ ## Using the TUI -`smol-k8s-lab` uses the [textual](https://www.textualize.io/) framework to create an interactive graphical interface in the terminal. +`smol-k8s-lab` uses the [textual](https://www.textualize.io/) framework to create an interactive graphical interface in the terminal. To get tips on how to navigate the TUI you can press `?` from within the TUI to get a help screen that looks like this: @@ -13,8 +13,8 @@ Some helpful tips: | key binding | description | |:-------------:|:------------| -| ++'?'++ | display the help screen | -| ++c++ | display the TUI config screen | +| ++'?'++ | display the help screen | +| ++c++ | display the TUI config screen | | ++f++ | show or hide the footer with key hints | | ++n++ | on the start screen, n will create a "new" cluster. All other screens this is "next" screen | | ++b++ / ++escape++ / ++q++ | Back a screen. If on the start screen, these quit the application |