From 8ae64525aefc8eee37270f2eb753092cd2e6c1db Mon Sep 17 00:00:00 2001 From: Cadence Ember Date: Tue, 6 Sep 2022 00:58:44 +1200 Subject: [PATCH] Add instances Odyssey346 and ~vern Also document required options. --- docs.scrbl | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs.scrbl b/docs.scrbl index 14a2063..e162de8 100644 --- a/docs.scrbl +++ b/docs.scrbl @@ -33,6 +33,8 @@ `((,(literal "Hoster") #f ,(literal "Link")) ("Cadence" "https://cadence.moe" "https://breezewiki.com") ("PussTheCat" "https://pussthecat.org" "https://breezewiki.pussthecat.org") + ("Odyssey346" "https://odyssey346.dev/" "https://bw.odyssey346.dev/") + ("~vern" "https://vern.cc/" "https://bw.vern.cc/") ))] @subsection{Tools} @@ -112,9 +114,13 @@ Now you can start BreezeWiki using one of the following methods. To be able to start up BreezeWiki faster, use @code{raco make dist.rkt} to byte-compile individual files. +@subsection{What next?} + +If you're running BreezeWiki in production (i.e. not for development) then check out the @secref["Required options"] section of the configuration page. + @; ----------------------------------------------------------------------------- -@section{Configuration} +@section[#:tag "Configuration"]{Configuration} @subsection{File} @@ -133,6 +139,14 @@ debug = false port = 10416 } +@subsection[#:tag "Required options"]{Required options} + +No options are strictly required, but some are highly recommended, depending on where you're running BreezeWiki. + +When running for local development, @code{debug = true} is recommended. + +When running in production, @code{canonical_origin} is highly recommended. + @subsection{Format} @itemlist[