Skip to content

Commit d172d8f

Browse files
committed
Readme edits
1 parent f215d51 commit d172d8f

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,23 @@
11
# SCTFE
22

3-
This personality implements https://c2sp.org/static-ct-api using
3+
This personality implements [CT Static API](https://c2sp.org/static-ct-api) using
44
Trillian Tessera to store data. It is based on [Trillian's CTFE](https://github.com/google/certificate-transparency-go/tree/master/trillian/ctfe).
55

6-
It is under active development, tracked under [Issue#88](https://github.com/transparency-dev/trillian-tessera/issues/88).
6+
It is under active development.
77

88
## Deployment
99
Each Tessera storage backend needs its own SCTFE binary.
1010

1111
At the moment, these storage backends are supported:
1212

13-
- [GCP](./ct_server_gcp)
14-
15-
16-
TODO(phbnf): add deployment instructions
17-
13+
- [GCP](./cmd/gcp/): [deployment instructions](./deployment/live/gcp/test/)
14+
- more to come soon!
1815

1916
## Working on the Code
2017
The following files are auto-generated:
21-
- [`config.pb.go`](./configpb/config.pb.go): SCTFE's config
2218
- [`mock_ct_storage.go`](./mockstorage/mock_ct_storage.go): a mock CT storage implementation for tests
2319

2420
To re-generate these files, first install the right tools:
25-
- [protobuf compiler and go gen](https://protobuf.dev/getting-started/gotutorial/#compiling-protocol-buffers). The protos in this repo have been built with protoc v27.3.
2621
- [mockgen](https://github.com/golang/mock?tab=readme-ov-file#installation)
2722

2823
Then, generate the files:
@@ -31,4 +26,7 @@ cd $(go list -f '{{ .Dir }}' github.com/transparency-dev/static-ct); \
3126
go generate -x ./... # hunts for //go:generate comments and runs them
3227
```
3328

34-
TODO(phboneff): provide docker template to build everything
29+
### Contact
30+
31+
- Slack: https://transparency-dev.slack.com/ ([invitation](https://join.slack.com/t/transparency-dev/shared_invite/zt-27pkqo21d-okUFhur7YZ0rFoJVIOPznQ))
32+
- Mailing list: https://groups.google.com/forum/#!forum/trillian-transparency

0 commit comments

Comments
 (0)