summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordberg.se>2015-04-03 19:48:20 +0200
committerLinus Nordberg <linus@nordberg.se>2015-04-03 19:48:20 +0200
commit2267289c354e440efecfb8a6e19cb965bd1bbbbc (patch)
treeddb039a6ff5721ff8ee4f04a2cf4b7e0fcf70d9a /README.md
parent459c5ebf083e5f076c17118d82ae16c080fdb9b5 (diff)
Update the instructions to start a small log.
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 47bbd93..5d3363f 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,6 @@
catlfish is a Certificate Transparency log server (RFC 6962).
-# Compile
-
- $ make
- $ make release
-
# Requirements
In order to compile catlfish, the following software packages are
@@ -29,9 +24,24 @@ command line, or install rebar yourself.
In order to perform merge operations, the following software packages
are needed: python-ecdsa, python-yaml
+# Compile
+
+ $ make
+ $ make release
+
# Start
- $ (cd rel ; bin/erl -config catlfish)
+This will set up and start a small test system with an empty log:
+
+ $ make tests-prepare tests-start
+
+To create an empty tree, do a first merge:
+
+ $ (cd catlfish; ../tools/merge.py --config ../test/catlfish-test.cfg --localconfig ../test/catlfish-test-local-merge.cfg)
+
+To submit a test cert and verify the resulting SCT:
+
+ $ (cd catlfish; ../tools/submitcert.py --parallel=1 --store ../tools/testcerts/pre2.txt --check-sct --sct-file=submittedcerts https://localhost:8080/ --publickey=tests/keys/logkey.pem)
# Logs and traces