From 87afb45711422f8cc4bc3a0c95d178633089546c Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordberg.se>
Date: Thu, 3 Mar 2022 13:30:19 +0100
Subject: clarify a few things on how to run the log

---
 cmd/sigsum_log_go/README.md | 10 +++++-----
 integration/run             | 21 +++++++++++----------
 2 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/cmd/sigsum_log_go/README.md b/cmd/sigsum_log_go/README.md
index 5e419ba..30567f8 100644
--- a/cmd/sigsum_log_go/README.md
+++ b/cmd/sigsum_log_go/README.md
@@ -5,10 +5,10 @@ is setup properly
 [here](https://github.com/google/certificate-transparency-go/blob/master/trillian/docs/ManualDeployment.md#data-storage).
 
 Other than the database we need Trillian log signer, Trillian log server, and
-sigsum-log-go.
+sigsum-log-go. sigsum-log-go has been tested with trillian v.1.3.13.
 ```
-$ go install github.com/google/trillian/cmd/trillian_log_signer
-$ go install github.com/google/trillian/cmd/trillian_log_server
+$ go install github.com/google/trillian/cmd/trillian_log_signer@v1.3.13
+$ go install github.com/google/trillian/cmd/trillian_log_server@v1.3.13
 $ go install
 ```
 
@@ -26,7 +26,7 @@ As described in more detail
 [here](https://github.com/google/certificate-transparency-go/blob/master/trillian/docs/ManualDeployment.md#trillian-services),
 we need to provision a Merkle tree once:
 ```
-$ go install github.com/google/trillian/cmd/createtree
+$ go install github.com/google/trillian/cmd/createtree@v1.3.13
 $ createtree --admin_server localhost:6962
 <tree id>
 ```
@@ -39,7 +39,7 @@ provisioned.)
 
 We will also need a public key-pair for sigsum-log-go.
 ```
-$ go install golang.sigsum.org/sigsum-log-go/cmd/tmp/keygen
+$ go install golang.sigsum.org/sigsum-log-go/cmd/tmp/keygen@v1.3.13
 $ ./keygen
 sk: <sk>
 vk: <vk>
diff --git a/integration/run b/integration/run
index f04ddf5..1e3e82c 100755
--- a/integration/run
+++ b/integration/run
@@ -10,16 +10,17 @@
 #
 # You will also need to install into your $GOPATH:
 #
-#     go install cmd/sigsum_log_go/main.go
-#     go install cmd/tmp/cosign/main.go
-#     go install cmd/tmp/submit/main.go
+#     go build -o $GOPATH/bin/sigsum_log_go cmd/sigsum_log_go/main.go
+#     go build -o $GOPATH/bin/sigsum_keygen cmd/tmp/keygen/main.go
+#     go build -o $GOPATH/bin/cosign cmd/tmp/cosign/main.go
+#     go build -o $GOPATH/bin/submit cmd/tmp/submit/main.go
 #
 # Run the test as follows:
 #
-#     1. start_tlog_seq ("terminal 1")
-#     2. start_tlog_serv ("terminal 2")
-#     3. start_sigsum_serv ("terminal 3")
-#     4. run ("terminal 4")
+#     1. integration/start_tlog_seq     # "terminal 1"
+#     2. integration/start_tlog_serv    # "terminal 2"
+#     3. integration/start_sigsum_serv  # "terminal 3"
+#     4. integration/run                # "terminal 4"
 #
 # What you expect to see is if the different endpoints function.
 #
@@ -59,7 +60,7 @@ $GOPATH/bin/cosign --url=$url --log_vk=$log_vk --sk=$wit_sk
 sleep $wait_seconds
 echo ""
 
-echo "test: get-tree-head-cosigned"
+echo "test: get-tree-head-cosigned (expect failure on first run with new log)"
 curl $url/get-tree-head-cosigned
 sleep $wait_seconds
 echo ""
@@ -69,7 +70,7 @@ curl $url/get-checkpoint
 sleep $wait_seconds
 echo ""
 
-echo "test: get-consistency-proof"
+echo "test: get-consistency-proof (expect failure on first run with new log)"
 printf "old_size=1\nnew_size=4\n" | curl --data-binary @- $url/get-consistency-proof
 sleep $wait_seconds
 echo ""
@@ -79,6 +80,6 @@ printf "start_size=0\nend_size=1\n" | curl --data-binary @- $url/get-leaves
 sleep $wait_seconds
 echo ""
 
-echo "with 30s interval we should now have a cosigned tree head"
+echo "with 30s interval we should now have a cosigned tree head (might fail on first run with new log)"
 curl $url/get-tree-head-cosigned
 echo ""
-- 
cgit v1.2.3