handlers

type GemlogToFeed struct {

	// Format to output the feed as, either `rss`, `atom`, or `json`. Defaults
	// to `atom`.
	Format string `json:"format"`

	// Optional name to provide in the output feed under author metadata.
	AuthorName string `json:"author_name"`

	// Optional email to provide in the output feed under author metadata.
	AuthorEmail string `json:"author_email"`

	// Optional URL in format `[scheme://host[:port]]/path` to use as the
	// absolute URL all links in the feed will be relative to. If not given then
	// it will be inferred from the request.
	BaseURL string `json:"base_url"`
	// contains filtered or unexported fields
}

type Gemtext struct {

	// Path to the template which will be used to render the HTML page, relative
	// to the `file_root`.
	//
	// The template will be rendered with these extra data fields:
	//
	// ##### `.Title`
	//
	// The Title of the gemini document, determined based on the first primary
	// header (single `#` prefix) found. This will be an empty string if no
	// primary header is found.
	//
	// ##### `.Body`
	//
	// A string containing all rendered HTML DOM elements.
	//
	TemplatePath string `json:"template"`

	// Path to a template which will be used for rendering headings. If not
	// given then headings will be rendered with appropriate HTML header tags.
	//
	// The template will be rendered with these extra data fields:
	//
	// ##### `.Level`
	//
	// Which level of heading is being rendered, 1, 2, or 3.
	//
	// ##### `.Text`
	//
	// The text of the heading.
	HeadingTemplatePath string `json:"heading_template"`

	// Path to a template which will be used for rendering links. If not given
	// then links will be rendered using an anchor tag wrapped in a paragraph
	// tag.
	//
	// The template will be rendered with these extra data fields:
	//
	// ##### `.URL`
	//
	// The URL the link points to.
	//
	// ##### `.Label`
	//
	// The label attached to the link. If the original link had no label then
	// this will be equivalent to `.URL`.
	LinkTemplatePath string `json:"link_template"`

	// The root path from which to load files. Default is `{http.vars.root}` if
	// set, or current working directory otherwise.
	FileRoot string `json:"file_root,omitempty"`

	// The template action delimiters. If set, must be precisely two elements:
	// the opening and closing delimiters. Default: `["{{", "}}"]`
	Delimiters []string `json:"delimiters,omitempty"`
	// contains filtered or unexported fields
}

type GitRemoteRepo struct {

	// The path of the git repo's directory. This directory will be created if
	// it doesn't already exist. Default is `{http.vars.root}` if set, or
	// current working directory otherwise.
	Path string `json:"path,omitempty"`
}

type ProofOfWork struct {

	// Secret is used to validate a PoW challenge seed. This string should never
	// be shared with clients, but _must_ be shared amongst all Caddy servers
	// which are serving the same domain.
	//
	// If not given then one will be generated on startup. Note that in this
	// case restarting Caddy will result in all clients requiring a new PoW
	// solution.
	Secret string `json:"secret,omitempty"`

	// Target is a uint32 indicating how difficult each challenge will be to
	// solve. A _lower_ Target value is more difficult than a higher one.
	//
	// Defaults to 0x000FFFFF
	Target uint32 `json:"target,omitempty"`

	// ChallengeTimeout indicates how long before Challenges are considered
	// expired and cannot be solved. Any solutions are also expired, and
	// browsers will be redirected back to the challenge page to solve a new
	// challenge.
	//
	// Defaults to 12h.
	ChallengeTimeout time.Duration `json:"challenge_timeout,omitempty"`

	// ChallengeSeedCookie indicates the name of the cookie which should be used
	// to store the challenge seed once a challenge has been solved.
	//
	// Defaults to "__pow_challenge_seed".
	ChallengeSeedCookie string `json:"challenge_seed_cookie,omitempty"`

	// ChallengeSolutionCookie indicates the name of the cookie which should be
	// used to store the challenge solution once a challenge has been solved.
	//
	// Defaults to "__pow_challenge_solution".
	ChallengeSolutionCookie string `json:"challenge_solution_cookie,omitempty"`

	// Path to HTML template to render in the browser when it is being
	// challenged. If not given then a simple default is shown.
	//
	// The template file should include the line
	// `<script>{{ template "pow.js" . }}</script>` at the end of the `body`
	// tag. This script will solve a challenge, set the solution to a cookie,
	// and reload the page.
	TemplatePath string `json:"template"`
	// contains filtered or unexported fields
}