ui

package
v1.2.0-alpha.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2026 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Start

func Start(currentVersion string) error

Start starts the HTTP server on listenAddr.

Types

type DNSStatus

type DNSStatus struct {
	OK  bool   `json:"ok"`
	TLD string `json:"tld"`
}

type PHPStatus

type PHPStatus struct {
	Version       string `json:"version"`
	Running       bool   `json:"running"`
	XdebugEnabled bool   `json:"xdebug_enabled"`
}

type ServiceActionResponse added in v0.1.23

type ServiceActionResponse struct {
	ServiceResponse
	OK    bool   `json:"ok"`
	Error string `json:"error,omitempty"`
	Logs  string `json:"logs,omitempty"`
}

ServiceActionResponse wraps the service state plus any error details.

type ServiceCheck

type ServiceCheck struct {
	Running bool `json:"running"`
}

type ServiceResponse

type ServiceResponse struct {
	Name               string            `json:"name"`
	Status             string            `json:"status"`
	EnvVars            map[string]string `json:"env_vars"`
	Dashboard          string            `json:"dashboard,omitempty"`
	Custom             bool              `json:"custom,omitempty"`
	SiteCount          int               `json:"site_count"`
	Pinned             bool              `json:"pinned"`
	DependsOn          []string          `json:"depends_on,omitempty"`
	QueueSite          string            `json:"queue_site,omitempty"`
	StripeListenerSite string            `json:"stripe_listener_site,omitempty"`
	ScheduleWorkerSite string            `json:"schedule_worker_site,omitempty"`
	ReverbSite         string            `json:"reverb_site,omitempty"`
	WorkerSite         string            `json:"worker_site,omitempty"`
	WorkerName         string            `json:"worker_name,omitempty"`
}

ServiceResponse is the response for GET /api/services.

type SettingsResponse added in v0.3.0

type SettingsResponse struct {
	AutostartOnLogin bool `json:"autostart_on_login"`
}

SettingsResponse is the response for GET /api/settings.

type SiteActionResponse added in v0.1.29

type SiteActionResponse struct {
	OK    bool   `json:"ok"`
	Error string `json:"error,omitempty"`
}

SiteActionResponse is returned by POST /api/sites/{domain}/secure|unsecure.

type SiteResponse

type SiteResponse struct {
	Name              string             `json:"name"`
	Domain            string             `json:"domain"`
	Path              string             `json:"path"`
	PHPVersion        string             `json:"php_version"`
	NodeVersion       string             `json:"node_version"`
	TLS               bool               `json:"tls"`
	Framework         string             `json:"framework"`
	FPMRunning        bool               `json:"fpm_running"`
	IsLaravel         bool               `json:"is_laravel"`
	FrameworkLabel    string             `json:"framework_label"`
	QueueRunning      bool               `json:"queue_running"`
	StripeRunning     bool               `json:"stripe_running"`
	StripeSecretSet   bool               `json:"stripe_secret_set"`
	ScheduleRunning   bool               `json:"schedule_running"`
	ReverbRunning     bool               `json:"reverb_running"`
	HasReverb         bool               `json:"has_reverb"`
	HasHorizon        bool               `json:"has_horizon"`
	HorizonRunning    bool               `json:"horizon_running"`
	HasQueueWorker    bool               `json:"has_queue_worker"`
	HasScheduleWorker bool               `json:"has_schedule_worker"`
	FrameworkWorkers  []WorkerStatus     `json:"framework_workers,omitempty"`
	Paused            bool               `json:"paused"`
	Branch            string             `json:"branch"`
	Worktrees         []WorktreeResponse `json:"worktrees"`
}

SiteResponse is the response for GET /api/sites.

type StatusResponse

type StatusResponse struct {
	DNS            DNSStatus    `json:"dns"`
	Nginx          ServiceCheck `json:"nginx"`
	PHPFPMs        []PHPStatus  `json:"php_fpms"`
	PHPDefault     string       `json:"php_default"`
	NodeDefault    string       `json:"node_default"`
	WatcherRunning bool         `json:"watcher_running"`
}

StatusResponse is the response for GET /api/status.

type VersionResponse

type VersionResponse struct {
	Current   string `json:"current"`
	Latest    string `json:"latest"`
	HasUpdate bool   `json:"has_update"`
	Changelog string `json:"changelog,omitempty"`
}

VersionResponse is the response for GET /api/version.

type WorkerStatus added in v1.0.0

type WorkerStatus struct {
	Name    string `json:"name"`
	Label   string `json:"label"`
	Running bool   `json:"running"`
}

WorkerStatus represents a single framework worker and its running state.

type WorktreeResponse added in v0.6.0

type WorktreeResponse struct {
	Branch string `json:"branch"`
	Domain string `json:"domain"`
	Path   string `json:"path"`
}

WorktreeResponse is embedded in SiteResponse for each git worktree.

Jump to

Keyboard shortcuts

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