xref: /aosp_15_r20/external/flashrom/util/docker/flashrom.org/README.md (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1*0d6140beSAndroid Build Coastguard Worker# doc.coreboot.org
2*0d6140beSAndroid Build Coastguard Worker Docker container for generating and developing documentation for doc.coreboot.org
3*0d6140beSAndroid Build Coastguard Worker
4*0d6140beSAndroid Build Coastguard Worker**NOTE**: All paths are from the base of the coreboot git repo.
5*0d6140beSAndroid Build Coastguard Worker
6*0d6140beSAndroid Build Coastguard Worker### Build
7*0d6140beSAndroid Build Coastguard Worker
8*0d6140beSAndroid Build Coastguard Worker```sh
9*0d6140beSAndroid Build Coastguard Worker  docker build --force-rm -t "doc.flashrom.org" "$PWD/util/docker/flashrom.org/"
10*0d6140beSAndroid Build Coastguard Worker```
11*0d6140beSAndroid Build Coastguard Worker
12*0d6140beSAndroid Build Coastguard Worker### Generating production HTML
13*0d6140beSAndroid Build Coastguard Worker
14*0d6140beSAndroid Build Coastguard Worker```sh
15*0d6140beSAndroid Build Coastguard Worker# To ensure the output directory is given the correct permissions, make sure to
16*0d6140beSAndroid Build Coastguard Worker# created it before running docker the first time.
17*0d6140beSAndroid Build Coastguard Workermkdir -p "$PWD/doc/_build/"
18*0d6140beSAndroid Build Coastguard Worker
19*0d6140beSAndroid Build Coastguard Workerdocker run -it --rm \
20*0d6140beSAndroid Build Coastguard Worker           --user "$(id -u):$(id -g)" \
21*0d6140beSAndroid Build Coastguard Worker           -v "$PWD/:/data-in/:ro" \
22*0d6140beSAndroid Build Coastguard Worker           -v "$PWD/doc/_build/:/data-out/" \
23*0d6140beSAndroid Build Coastguard Worker           doc.flashrom.org
24*0d6140beSAndroid Build Coastguard Worker```
25*0d6140beSAndroid Build Coastguard Worker
26*0d6140beSAndroid Build Coastguard Worker### live reloaded with web server
27*0d6140beSAndroid Build Coastguard WorkerOn the host machine, open a browser to the address http://0.0.0.0:8000
28*0d6140beSAndroid Build Coastguard Worker```sh
29*0d6140beSAndroid Build Coastguard Workerdocker run -it --rm \
30*0d6140beSAndroid Build Coastguard Worker           --net=host -v "$PWD/:/data-in/:ro" \
31*0d6140beSAndroid Build Coastguard Worker           doc.flashrom.org livehtml
32*0d6140beSAndroid Build Coastguard Worker```
33