lukaszraczylo/kportal
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/kportal.git synced 2026-07-14 07:51:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: sync website + README + wizard guide + changelog with new features

Browse Source 
docs/index.html (kportal.raczylo.com):
  - Features grid gains Bulk Generate, Sensitive Header Redaction,
    Verified Installer cards; Headless card subtext clarified to
    'logs to stderr'.
  - Keybindings: 'a' -> 'n' for Add (matches real binding).
  - Quick Install card notes SHA-256 + optional cosign verification
    and DRY_RUN / SKIP_COSIGN env vars.
  - New Bulk Generate usage tile with --dry-run hint; Headless tile
    redirects stderr.
  - HTTP Traffic Logging card mentions automatic header redaction
    and the wizard 'h' toggle.

README.md:
  - install.sh note expanded with DRY_RUN/SKIP_COSIGN table.
  - HTTP Traffic Logging section gains 'Toggling per-forward
    logging', 'Header redaction', and 'Advanced configuration'
    examples.
  - Headless mode clarified to log to stderr (2>kportal.log).
  - Troubleshooting note on accepted context-name characters.

WIZARD_USAGE.md:
  - Add binding corrected from 'a' to 'n'; 'e' (edit) row added.
  - 'h' httpLog toggle and Tab focus switch documented.
  - New 'Edit Forward Wizard' section noting same-port allowed and
    advanced httpLog preserved.
  - Esc-cancels-delete behaviour clarified.

CHANGELOG.md: [Unreleased] populated with Added / Changed / Fixed
entries for this session's user-facing work, dated 2026-05-06.

.kportal.yaml example: inline 'httpLog: true' comment on one
forward as a usage hint.
This commit is contained in:
Lukasz Raczylo
2026-05-06 15:03:35 +01:00
parent 0c11838326
commit 62483f9475
5 changed files with 136 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
WIZARD_USAGE.md
+16 -5
View File
@@ -1,17 +1,18 @@
# Interactive Wizards
kportal includes wizards for adding and removing port forwards from the running UI.
kportal includes wizards for adding, editing, and removing port forwards from the running UI.
## ⌨️ Quick Reference
| Key | Action |
|-----|--------|
| `a` | Add new forward |
| `n` | Add new forward |
| `e` | Edit selected forward |
| `d` | Delete forwards |
## ➕ Add Forward Wizard
Press `a` from the main view to start the wizard.
Press `n` from the main view to start the wizard.
### Steps
@@ -21,7 +22,7 @@ Press `a` from the main view to start the wizard.
4. **Resource** - Enter prefix, selector, or select service
5. **Remote Port** - Enter port on the resource
6. **Local Port** - Enter local port (validates availability)
7. **Confirm** - Review and optionally add an alias
7. **Confirm** - Review, optionally add an alias, and toggle HTTP logging
### Navigation
@@ -31,6 +32,16 @@ Press `a` from the main view to start the wizard.
| `Enter` | Confirm and proceed |
| `Esc` | Go back / Cancel |
| `Ctrl+C` | Cancel immediately |
| `h` | Toggle HTTP traffic logging (confirmation step, when alias not focused) |
| `Tab` | Switch focus between alias field and buttons (confirmation step) |
## ✏️ Edit Forward Wizard
Press `e` on a selected row to edit it. The wizard reuses the add flow with values
pre-filled. The local-port availability check skips the forward being edited, so
keeping the same local port is always allowed. Advanced `httpLog` settings
(`logFile`, `includeHeaders`, `maxBodySize`, `filterPath`) defined in YAML are
preserved when toggling `httpLog` with `h`.
## 🗑️ Delete Forward Wizard
@@ -45,7 +56,7 @@ Press `d` from the main view.
| `a` | Select all |
| `n` | Deselect all |
| `Enter` | Confirm deletion |
| `Esc` | Cancel |
| `Esc` | Cancel (does not confirm deletion) |
## 🎯 Resource Selection