Skip to content

Add links to READMEs #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# SCTFE

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

It is under active development.

Expand All @@ -21,6 +23,7 @@ To re-generate these files, first install the right tools:
- [mockgen](https://github.com/golang/mock?tab=readme-ov-file#installation)

Then, generate the files:

```bash
cd $(go list -f '{{ .Dir }}' github.com/transparency-dev/static-ct); \
go generate -x ./... # hunts for //go:generate comments and runs them
Expand Down
6 changes: 5 additions & 1 deletion deployment/live/gcp/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Prerequisites
You'll need to have a VM running in the same GCP project that you can SSH to,
with Go installed, and your favourite terminal multiplexer.
with [Go](https://go.dev/doc/install) and
[terragrunt](https://terragrunt.gruntwork.io/docs/getting-started/install/)
installed, and your favourite terminal multiplexer.

## Overview

Expand All @@ -19,11 +21,13 @@ At a high level, this environment consists of:

First authenticate via `gcloud` as a principle with sufficient ACLs for
the project:

```bash
gcloud auth application-default login
```

Set the required environment variables:

```bash
export GOOGLE_PROJECT={VALUE}
export GOOGLE_REGION={VALUE} # e.g: us-central1
Expand Down
Loading