Merge branch 'extsign'

1 files changed, 34 insertions, 0 deletions

diff --git a/examples/docker-minimal/README b/examples/docker-minimal/README
new file mode 100644
index 0000000..9334909
--- /dev/null
+++ b/examples/docker-minimal/README
@@ -0,0 +1,34 @@
+Given a docker image 'catlfish' as defined in
+catlfish/packaging/docker, here is an example of a minimal catlfish
+log using one docker container to run one single Erlang beam instance
+for both a frontend and a storage node and an example of how to start
+a shell script in the host system performing merge periodically.
+
+Create the docker image
+
+    $ docker build -t my-single-image-catlfish docker
+
+Run the newly created image in a docker container
+
+    $ docker run --name=my-catlfish --detach=true --publish 127.0.0.1:8080-8082:8080-8082/tcp my-single-image-catlfish
+
+This will create and start one container listening for cert chain
+submissions on https://127.0.0.1:8080/.
+
+
+In order to start a shell script doing merge (i.e. generate new STH's)
+with an interval of 20 minutes (with the first merge occuring five
+minutes after startup) in the host system, cd into the catlfish
+directory and run examples/docker-minimal/docker/merge.sh.
+
+
+To submit a cert chain and verify the resulting SCT, try the
+submitcert tool:
+
+    $ tools/submitcert.py --store=tools/testcerts/cert1.txt --check-sct --sct-file=/tmp/cert1-sct https://127.0.0.1:8080/
+
+
+Where are the log files? Try running a shell in the container and poke
+around in the /opt/catlfish/log directory. Here's how to start one:
+
+    $ docker exec -it my-catlfish /bin/bash