summaryrefslogtreecommitdiffstats
path: root/util/docker/flashrom.org/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/docker/flashrom.org/README.md')
-rw-r--r--util/docker/flashrom.org/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/util/docker/flashrom.org/README.md b/util/docker/flashrom.org/README.md
new file mode 100644
index 000000000..313d0d768
--- /dev/null
+++ b/util/docker/flashrom.org/README.md
@@ -0,0 +1,32 @@
+# doc.coreboot.org
+ Docker container for generating and developing documentation for doc.coreboot.org
+
+**NOTE**: All paths are from the base of the coreboot git repo.
+
+### Build
+
+```sh
+ docker build --force-rm -t "doc.flashrom.org" "$PWD/util/docker/flashrom.org/"
+```
+
+### Generating production HTML
+
+```sh
+# To ensure the output directory is given the correct permissions, make sure to
+# created it before running docker the first time.
+mkdir -p "$PWD/doc/_build/"
+
+docker run -it --rm \
+ --user "$(id -u):$(id -g)" \
+ -v "$PWD/:/data-in/:ro" \
+ -v "$PWD/doc/_build/:/data-out/" \
+ doc.flashrom.org
+```
+
+### live reloaded with web server
+On the host machine, open a browser to the address http://0.0.0.0:8000
+```sh
+docker run -it --rm \
+ --net=host -v "$PWD/:/data-in/:ro" \
+ doc.flashrom.org livehtml
+```