summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README54
1 files changed, 54 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..368a8a8
--- /dev/null
+++ b/README
@@ -0,0 +1,54 @@
+Information about creating a docker image for running catlfish from a
+binary release or with catlfish built from source.
+
+
+Requirements
+------------
+
+- lack of expectations regarding security -- docker doesn't verify
+ downloaded images
+- a 64-bit Linux system
+- lxc-docker version 1.3 or later
+
+
+Building an image
+-----------------
+
+ $ make catlfish-dev # development image
+
+or
+
+ $ make catlfish # release image
+
+
+Configuring a log
+-----------------
+
+XXX create CA and certs; create logkey (possibly in softhsm); create
+XXX auth keys; run compileconfig.py for each node
+
+
+Running
+-------
+
+Example:
+
+ $ docker run -d --name mylog-signing \
+ -v $(pwd)/signing:/usr/local/etc/catlfish:ro \
+ -p $SIGNING_IP:8288:8288 \
+ catlfish mylog signing mylog-signing
+ $ docker run -d --name mylog-storage \
+ -v $(pwd)/storage:/usr/local/etc/catlfish:ro \
+ -p $STORAGE_IP:8081:8081 \
+ catlfish mylog storage mylog-storage
+ $ docker run -d --name mylog-frontend \
+ -v $(pwd)/frontend:/usr/local/etc/catlfish:ro \
+ -v /path/to/dbdir:/var/local/db/catlfish
+ -p $FRONTEND_IP:8080:8080 \
+ -p $FRONTEND_IP:8082:8082 \
+ catlfish mylog frontend mylog-frontend
+ $ docker run -d --name mylog-merge \
+ -e MERGE_DB_DIR=/var/local/db/catlfish-merge
+ -v $(pwd)/merge:/usr/local/etc/catlfish:ro \
+ -v /path/to/merge-dbdir:/var/local/db/catlfish-merge
+ catlfish mylog merge mylog-merge