On this page:
4.1 Running a compiled executable
4.2 Running the source code
4.3 Running with Docker
4.4 What next?

4 Running

4.1 Running a compiled executable

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.

  1. Download the distribution: https://docs.breezewiki.com/files/breezewiki-dist.tar.gz

  2. Unpack the archive.

  3. Execute the binary breezewiki-dist/bin/dist.

4.2 Running the source code

This method is recommended for people who want to edit the source code, or for people who can’t use the compiled distribution.

  1. Install Racket. Please install the latest version. 8.4 or later is required.

  2. Clone the repository from https://gitdab.com/cadence/breezewiki.

  3. 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.

To be able to start up BreezeWiki faster, use raco make dist.rkt to byte-compile individual files.

4.3 Running with Docker

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

4.4 What next?

If you’re running BreezeWiki in production (i.e. not for development) then check out the Required options section of the configuration page.