web

Documentation

Overview

Package web is `rig web`: the control plane in a browser, served on this machine. The page is static; everything it shows comes from the Engine API (the calls `rig serve` answers), behind a token the printed link carries.

Index

• type Handler
  • func (h *Handler) Close()
  • func (h *Handler) Engine(env string) (*engine.Local, error)
  • func (h *Handler) Routes() http.Handler

Types

type Handler

type Handler struct {
	File  string
	Token string
	// Open opens the project on an environment ("" is its default).
	Open func(file, env string) (*engine.App, error)
	// Info is merged into GET /v1/web: themes, the chosen theme, the version.
	Info map[string]any
	// contains filtered or unexported fields
}

func (*Handler) Close

func (h *Handler) Close()

func (*Handler) Engine

func (h *Handler) Engine(env string) (*engine.Local, error)

Engine is the engine for env, opened once; opening one environment never waits on another.

func (*Handler) Routes

func (h *Handler) Routes() http.Handler