|
@@ -1,17 +1,25 @@
|
|
|
## Usage
|
|
## Usage
|
|
|
|
|
|
|
|
-First, run `init.sh` to prepare the production ready environment. `init.sh` does the
|
|
|
|
|
-following, in order.
|
|
|
|
|
|
|
+First, download the release of writefreely for your operating system. See
|
|
|
|
|
+[the releases page](https://github.com/writefreely/writefreely/releases) on
|
|
|
|
|
+GitHub.
|
|
|
|
|
+
|
|
|
|
|
+Next, run `init.sh` to prepare the production ready environment. `init.sh` does
|
|
|
|
|
+the following in order.
|
|
|
|
|
|
|
|
1. Copies a writefreely tarball to `./bootstrap`
|
|
1. Copies a writefreely tarball to `./bootstrap`
|
|
|
|
|
|
|
|
2. Uses `docker run` to run `writefreely config start`, copying results to
|
|
2. Uses `docker run` to run `writefreely config start`, copying results to
|
|
|
`./bootstrap/data`
|
|
`./bootstrap/data`
|
|
|
|
|
|
|
|
-3. Copies a writefreely tarball to `./production`, alonside files from
|
|
|
|
|
|
|
+3. Copies a writefreely tarball to `./production`, alongside files from
|
|
|
`./bootstrap/data`
|
|
`./bootstrap/data`
|
|
|
|
|
|
|
|
4. Runs `docker compose build` to create the image
|
|
4. Runs `docker compose build` to create the image
|
|
|
|
|
|
|
|
-Next, edit the `docker-compose.yml` file in `./production`. The existing compose
|
|
|
|
|
-file provides some sensible defaults, but you may customize as you see fit.
|
|
|
|
|
|
|
+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.
|
arianagiroux