Sfoglia il codice sorgente

Added some documentation updates

arianagiroux 1 mese fa
parent
commit
928945e673
2 ha cambiato i file con 20 aggiunte e 2 eliminazioni
  1. 17 1
      Readme.md
  2. 3 1
      production/docker-compose.yml

+ 17 - 1
Readme.md

@@ -1 +1,17 @@
-1. docker build -t writefreely .
+## Usage
+
+First, 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`, alonside files from
+   `./bootstrap/data`
+
+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.

+ 3 - 1
production/docker-compose.yml

@@ -3,8 +3,10 @@ services:
     build:
       context: .
     volumes:
-      - writefreely_data:/app/writefreely
+      # bind the writefreely app data to a volume, enabling persistence
+      - writefreely_data:/app/writefreely 
     ports:
+      # bind a host port to he container port (ie, HOST:CONTAINER)
       - 8088:8080
 
 volumes: