This method is recommended for people who do not want to edit the source code.
The distribution includes the Racket runtime, libraries, and everything else needed to run BreezeWiki.
Download the distribution: https://docs.breezewiki.com/files/breezewiki-dist.tar.gz
Unpack the archive.
Execute the binary breezewiki-dist/bin/dist.
This method is recommended for people who want to edit the source code, or for people who can’t use the compiled distribution.
Install Racket. Please install the latest version. 8.4 or later is required.
Clone the repository from https://gitdab.com/cadence/breezewiki.
Run raco pkg install --auto --skip-installed in the repository to install dependencies.
If building in an automated environment, like CI, use the flags --batch --auto --no-docs --skip-installed.
Now you can start BreezeWiki using one of the following methods.
Run racket dist.rkt to start BreezeWiki.
Evaluate breezewiki.rkt in DrRacket or in the Racket REPL to start BreezeWiki with module hot-reloading. Helpful for development!
To be able to start up BreezeWiki faster, use raco make dist.rkt to byte-compile individual files.
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.
Image provided by PussTheCat.org: https://github.com/PussTheCat-org/docker-breezewiki-quay
If you’re running BreezeWiki in production (i.e. not for development) then check out the Required options section of the configuration page.