forked from cadence/breezewiki-docs
Add instances Odyssey346 and ~vern
Also document required options.
This commit is contained in:
parent
f6693f9db8
commit
8ae64525ae
1 changed files with 15 additions and 1 deletions
16
docs.scrbl
16
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[
|
||||
|
|
Loading…
Reference in a new issue