From 4e705e766fa201c0c59d795ea6abcf452162f114 Mon Sep 17 00:00:00 2001 From: Christian Heimlich Date: Thu, 2 Feb 2023 17:08:06 -0500 Subject: [PATCH] chore(kasm): Add basic Kasm installation information (#6819) * Add basic Kasm installation information * bump --------- Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> --- charts/stable/kasm/Chart.yaml | 3 +-- charts/stable/kasm/docs/installation_notes.md | 26 +++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 charts/stable/kasm/docs/installation_notes.md diff --git a/charts/stable/kasm/Chart.yaml b/charts/stable/kasm/Chart.yaml index 7cd745dcae0..12a1e4ba156 100644 --- a/charts/stable/kasm/Chart.yaml +++ b/charts/stable/kasm/Chart.yaml @@ -24,9 +24,8 @@ name: kasm sources: - https://github.com/truecharts/charts/tree/master/charts/stable/kasm - https://hub.docker.com/kasmweb/workspaces - - kasmweb/workspaces - https://www.kasmweb.com/ - https://github.com/orgs/linuxserver/packages/container/package/kasm - https://github.com/linuxserver/docker-kasm#readme type: application -version: 3.2.3 +version: 3.2.4 diff --git a/charts/stable/kasm/docs/installation_notes.md b/charts/stable/kasm/docs/installation_notes.md new file mode 100644 index 00000000000..29283c51046 --- /dev/null +++ b/charts/stable/kasm/docs/installation_notes.md @@ -0,0 +1,26 @@ +# Installation Notes + +## Services + +This chart provides two services: + +- Main Service +- Admin Service + +The Main Service provides the primary functionality of the chart, while the Admin service is used for first-time setup and generally does not need to be accessed afterwards. + +## Configuration + +The admin service **must** first be used to setup Kasm before the main service can be accessed. + +Connect to the admin service at `https://HOST_IP:PORT` (10351 by default) and follow the prompts to complete the initial setup. Once you are at the dashboard you can switch over to the main service and login with the user you just configured. + +:::info + +You cannot use ingress to access the admin service, it must be accessed via host-ip/port. + +::: + +Attempting to access the main service before doing this will result in `ERR_CONNECTION_REFUSED`. + +At this point, if you wish, you can change the admin service networking from `LoadBalancer` to `ClusterIP` to conceal its port since you likely won't need to access it again.