summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index bdbe5c9..af5e4fb 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ The catlfish software has the following properties:
In order to compile catlfish, the following software packages are
needed:
-- A compiled https://git.nordu.net/plop.git application in ../plop
+- A compiled https://git.nordu.net/plop.git in ../plop
- A compiled https://github.com/basho/lager (for logging) in ../lager
@@ -34,6 +34,8 @@ needed:
- A compiled https://github.com/benoitc/hackney.git (http client) in
../hackney
+- nettle-dev, libbsd-dev, librhash-dev (for using the permdb backend)
+
Note: hackney is dependent on rebar, but doesn't include one. You can
use the rebar from lager by adding "REBAR=../lager/rebar" to the make
command line, or install rebar yourself.
@@ -42,7 +44,7 @@ In order to perform merge operations, the following software packages
are needed: python-ecdsa, python-yaml.
In order to use the tools for submitting certificates, the following
-software package is needed: python-pyasn1.
+software packages are needed: python-pyasn1, unzip.
In order to run the tests, the following software packagess are
needed: curl.
@@ -53,14 +55,11 @@ needed: curl.
# Start
-This will set up and start a small test system with an empty log:
+This will set up and start a small test system and run some tests on
+it:
$ make tests
-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)