cadence
/
breezewiki-docs
2
1
Fork 2
Code Issues Pull Requests Releases Activity

Explain how to update; add bind_host setting

This commit is contained in:
Cadence Ember 2023-03-21 00:14:14 +13:00
parent ed81287064
commit 6b854ecebf
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs.scrbl
View File

@ -146,14 +146,12 @@ The distribution includes the Racket runtime, libraries, and everything else nee
This method is recommended for people who want to edit the source code, or for people who can't use the compiled distribution.
@itemlist[#:style 'ordered
@item{Install Racket. Please install the latest version. 8.4 or later is required.}
@item{Install Racket. Please install the latest version. 8.4 or later is required. @hyperlink["https://download.racket-lang.org/" "Download it here if your package manager is old."]}
@item{Clone the repository from @url{https://gitdab.com/cadence/breezewiki}.}
@item{Run @code{raco pkg install --auto req} to install the @code{raco req} command.}
@item{Run @code{raco req -d} in the repository to install dependencies.}
]
@nested[#:style (style "block-note" null)]{If building in an automated environment, like CI, instead use @code{raco pkg install --batch --auto --no-docs --skip-installed req}.}
Now you can start BreezeWiki using one of the following methods.
@itemlist[
@ -163,6 +161,18 @@ 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.
@nested[#:style (style "block-note" null)]{If building in an automated environment, like CI or Docker, use @code{raco pkg install --batch --auto --no-docs --skip-installed req-lib} instead of step 3 above.}
@subsection{Updating the source code}
If you are running BreezeWiki from source code, you will need to follow these steps any time you pull the latest version. (Not required when running the executable or Docker.)
@itemlist[#:style 'ordered
@item{Make sure your version of Racket is still new enough to run BreezeWiki. The required version is listed above.}
@item{Run @code{raco pkg update --all} to update existing dependencies.}
@item{Run @code{raco req -d} to install any new dependencies.}
]
@subsection{Running with Docker}
@nested[#:style (style "block-note" null)]{There is no official Docker support. Information herein is created by members of the community. Using Docker makes it more difficult to debug and find help if you encounter problems.}
@ -199,11 +209,12 @@ When running a compiled distribution of BreezeWiki, the main @code{config.ini} f
Here is an example configuration file. It shows all the available settings and all their defaults.
@verbatim{
bind_host = auto
port = 10416
canonical_origin =
debug = false
feature_search_suggestions = true
log_outgoing = true
port = 10416
strict_proxy = true
}
@ -242,6 +253,14 @@ When running in production, @code{canonical_origin} is highly recommended.
@subsection{Detailed Options}
@defthing[bind_host value #:value "auto"]{
Which hostname to run the server on. The default value is auto. Auto means 127.0.0.1 in debug mode, otherwise, all interfaces. If you don't know what this means, don't change it.
}
@defthing[port value #:value "10416"]{
Which port to run the server on.
}
@defthing[canonical_origin value #:value ""]{
The primary URL where people can access the homepage of your instance.
@ -264,10 +283,6 @@ When enabled, any text typed in the search box will be sent to Fandom servers in
Whether to log outgoing requests to Fandom to the console.
}
@defthing[port value #:value "10416"]{
Which port to run the server on.
}
@defthing[strict_proxy boolean #:value "true"]{
Whether to put more URLs through the proxy. If false, just a minimal set is proxied. If true, additionally proxies page stylesheets and links to image files, thereby reducing the potential for end-users to connect to Fandom servers.
}