## Usage

First, download the release of writefreely for your operating system. See
[the releases page](https://github.com/writefreely/writefreely/releases) on 
GitHub and place it in the root of this repository.

Next, run `init.sh` to prepare the production ready environment. `init.sh` does
the following in order.

1. Copies a writefreely tarball to `./bootstrap`

2. Uses `docker run` to run `writefreely config start`, copying results to
   `./bootstrap/data`

3. Copies a writefreely tarball to `./production`, alongside files from
   `./bootstrap/data`

4. Runs `docker compose build` to create the image

Finally, edit the `docker-compose.yml` file in `./production`. The existing
compose file provides some sensible defaults, but you may customize as you see
fit.

When ready, use `cd` into `production` and use `docker compose up` to run the
resulting production ready image.

## Contributing & bug reports

To contribute:

 - commit all changes to a publicly accessible git repository.

 - add the output of `git request-pull` and a description of your changes to
   `cc-writefreely@googlegroups.com` via email or through the
   [web ui](https://groups.google.com/g/cc-writefreely).