README
¶
Distributor
Overview
The distributor is a RESTful service that makes witnessed checkpoints available.
Running in Docker
The distributor can be started using docker compose.
The following command will bring up the distributor on port 8080:
docker compose up -d
Note that this will only accept witnessed checkpoints from witnesses in the
config/witnesses-dev.yaml directory.
To change the permitted witnesses, modify the docker-compose.yaml file to
include a different file, or configure the distributor binary with the witnesses
specified directly via the witKey flag.
Support
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides the API endpoints for the distributor.
|
Package api provides the API endpoints for the distributor. |
|
Package client contains a simple RESTful client that retrieves information from a distributor at a known URL.
|
Package client contains a simple RESTful client that retrieves information from a distributor at a known URL. |
|
distributor is a server designed to make witnessed checkpoints of verifiable logs available to clients in an efficient manner.
|
distributor is a server designed to make witnessed checkpoints of verifiable logs available to clients in an efficient manner. |
|
client
command
client is a simple client that demonstrates fetching data from a distributor.
|
client is a simple client that demonstrates fetching data from a distributor. |
|
internal/distributor
Package distributor contains a DB-backed object that persists witnessed checkpoints of verifiable logs and allows them to be queried to allow efficient lookup by-witness, and by number of signatures.
|
Package distributor contains a DB-backed object that persists witnessed checkpoints of verifiable logs and allows them to be queried to allow efficient lookup by-witness, and by number of signatures. |
|
internal/http
Package http contains private implementation details for the distributor server.
|
Package http contains private implementation details for the distributor server. |
|
Package config has top-level configs etc.
|
Package config has top-level configs etc. |
|
internal
|
|
|
checkpoints
Package checkpoints provides functionality for handling checkpoints.
|
Package checkpoints provides functionality for handling checkpoints. |
|
testonly/docker
Package docker provides functions for integration tests that rely on Docker.
|
Package docker provides functions for integration tests that rely on Docker. |
Click to show internal directories.
Click to hide internal directories.