TrueChartsClone/charts/stable/kasm/docs/installation_notes.md

29 lines
1.0 KiB
Markdown
Raw Normal View History

chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
2023-12-31 09:24:05 -05:00
---
title: 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.