webtty

package

v0.10.1 Latest Latest Go to latest Published: May 12, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/yogasw/wick

Links

Open Source Insights

Documentation ¶

Overview ¶

Package webtty mounts a browser-based terminal under /tools/webtty. It wraps github.com/yogasw/web-tty, which spawns gotty internally and proxies HTTP + WebSocket traffic — no extra port is exposed outside the host.

The tool is admin-only (System tag) and can be toggled on/off via the Enabled config flag without a redeploy.

templ: version: v0.3.1020

Index ¶

Variables
func IndexBody(basePath string, enabled bool) templ.Component
func Register(r tool.Router)
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var StaticFS embed.FS

Functions ¶

func IndexBody ¶

func IndexBody(basePath string, enabled bool) templ.Component

func Register ¶

func Register(r tool.Router)

Register wires webtty routes on the scoped Router.

Types ¶

type Config ¶

type Config struct {
	// Enabled controls whether the terminal is accessible. When false,
	// the tool page shows a disabled notice instead of the terminal.
	Enabled bool `wick:"desc=Enable or disable the web terminal. When disabled, the page shows a notice instead of the terminal.;checkbox"`
}

Config holds the runtime-editable knobs for the web terminal tool.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL