A simple init script solution for a docker compose ready WriteFreely instance.

arianagiroux 9a4ecace02 Added information on contribution & bug reporting 1 månad sedan
bootstrap c627ea5c95 Scripted bootstrapping process 1 månad sedan
production 928945e673 Added some documentation updates 1 månad sedan
.gitignore 51d8307340 Added ignore for default files 1 månad sedan
LICENSE 05fcc1cce3 Added a license file (MIT) 1 månad sedan
Readme.md 9a4ecace02 Added information on contribution & bug reporting 1 månad sedan
init.sh cbfc841fa4 Caught an extra error 1 månad sedan
track_defaults.patch 6dd120f1db Added a patch for tracking a few ignored files 1 månad sedan

Readme.md

Usage

First, download the release of writefreely for your operating system. See the releases page 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.