summaryrefslogtreecommitdiff
path: root/examples/docker-minimal-separate/README
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordberg.se>2015-02-24 19:26:21 +0100
committerLinus Nordberg <linus@nordberg.se>2015-02-24 22:31:42 +0100
commit307071e1b0d536abbec277764b427d145d4f42b7 (patch)
treea23013c9ce6c21af2752118d46d0200c230a38bd /examples/docker-minimal-separate/README
parent81a35a696d813ac5803afe602e549b56a9dfd9c4 (diff)
Add packaging and examples.
Diffstat (limited to 'examples/docker-minimal-separate/README')
-rw-r--r--examples/docker-minimal-separate/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/docker-minimal-separate/README b/examples/docker-minimal-separate/README
new file mode 100644
index 0000000..afb5f64
--- /dev/null
+++ b/examples/docker-minimal-separate/README
@@ -0,0 +1,18 @@
+Given a docker image 'catlfish' as defined in
+catlfish/packaging/docker, here is an example of a minimal catlfish
+instance using three docker containers to run a single frontend node,
+a single storage node and a third system for merge.
+
+First, edit frontend/catlfish.config and replace MY-PUBLIC-ADDRESS
+with an IP address or DNS name for the interface on the host system
+that is most likely to play well with docker. (This part of the
+instructions can most certainly be improved by someone with some
+docker skills!)
+
+Then, run
+
+ $ docker build -t my-single-node-catlfish docker
+
+How to run the single node catlfish image:
+
+ $ docker run my-single-node-catlfish