site

Documentation

Index

• func ExtractOrReadBinFS(dest string, siteFS fs.FS) (http.FileSystem, map[string]string, error)
• func FS() fs.FS
• func Handler(siteFS fs.FS, binFS http.FileSystem, binHashes map[string]string) http.Handler
• func RenderStaticErrorPage(rw http.ResponseWriter, r *http.Request, data ErrorPageData)
• func ShouldCacheFile(reqFile string) bool
• type ErrorPageData

Functions

func ExtractOrReadBinFS

func ExtractOrReadBinFS(dest string, siteFS fs.FS) (http.FileSystem, map[string]string, 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).

Returns a http.FileSystem that serves unpacked binaries, and a map of binary name to SHA1 hash. The returned hash map may be incomplete or contain hashes for missing files.

func FS

func FS() fs.FS

func Handler

func Handler(siteFS fs.FS, binFS http.FileSystem, binHashes map[string]string) 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 ErrorPageData

type ErrorPageData struct {
	Status int
	// HideStatus will remove the status code from the page.
	HideStatus   bool
	Title        string
	Description  string
	RetryEnabled bool
	DashboardURL string
}

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