site

Documentation

Index

• Constants
• func ExtractOrReadBinFS(dest string, siteFS fs.FS) (http.FileSystem, error)
• func FS() fs.FS
• func Handler(siteFS fs.FS, binFS http.FileSystem) http.Handler
• func RenderStaticErrorPage(rw http.ResponseWriter, r *http.Request, data ErrorPageData)
• func ShouldCacheFile(reqFile string) bool
• type CSPDirectives
  • func (s CSPDirectives) Append(d CSPFetchDirective, values ...string)
• type CSPFetchDirective
• type ErrorPageData

Constants

const (
	CSPDirectiveDefaultSrc  = "default-src"
	CSPDirectiveConnectSrc  = "connect-src"
	CSPDirectiveChildSrc    = "child-src"
	CSPDirectiveScriptSrc   = "script-src"
	CSPDirectiveFontSrc     = "font-src"
	CSPDirectiveStyleSrc    = "style-src"
	CSPDirectiveObjectSrc   = "object-src"
	CSPDirectiveManifestSrc = "manifest-src"
	CSPDirectiveFrameSrc    = "frame-src"
	CSPDirectiveImgSrc      = "img-src"
	CSPDirectiveReportURI   = "report-uri"
	CSPDirectiveFormAction  = "form-action"
	CSPDirectiveMediaSrc    = "media-src"
	CSPFrameAncestors       = "frame-ancestors"
)

Functions

func ExtractOrReadBinFS

func ExtractOrReadBinFS(dest string, siteFS fs.FS) (http.FileSystem, error)

ExtractOrReadBinFS checks the provided fs for compressed coder binaries and extracts them into dest/bin if found. As a fallback, the provided FS is checked for a /bin directory, if it is non-empty it is returned. Finally dest/bin is returned as a fallback allowing binaries to be manually placed in dest (usually ${CODER_CACHE_DIRECTORY}/site/bin).

func FS

func FS() fs.FS

func Handler

func Handler(siteFS fs.FS, binFS http.FileSystem) http.Handler

Handler returns an HTTP handler for serving the static site.

func RenderStaticErrorPage

func RenderStaticErrorPage(rw http.ResponseWriter, r *http.Request, data ErrorPageData)

RenderStaticErrorPage renders the static error page. This is used by app requests to avoid dependence on the dashboard but maintain the ability to render a friendly error page on subdomains.

func ShouldCacheFile

func ShouldCacheFile(reqFile string) bool

Types

type CSPDirectives

type CSPDirectives map[CSPFetchDirective][]string

CSPDirectives is a map of all csp fetch directives to their values. Each directive is a set of values that is joined by a space (' '). All directives are semi-colon separated as a single string for the csp header.

func (CSPDirectives) Append

func (s CSPDirectives) Append(d CSPFetchDirective, values ...string)

type CSPFetchDirective

type CSPFetchDirective string

CSPFetchDirective is the list of all constant fetch directives that can be used/appended to.

type ErrorPageData

type ErrorPageData struct {
	Status       int
	Title        string
	Description  string
	RetryEnabled bool
	DashboardURL string
}

ErrorPageData contains the variables that are found in site/static/error.html.