Categorygithub.com/transparency-dev/distributor
module
0.2.1
Repository: https://github.com/transparency-dev/distributor.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

Distributor

Go Reference Go Report Card OpenSSF Scorecard Slack Status

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

# Packages

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.
distributor is a server designed to make witnessed checkpoints of verifiable logs available to clients in an efficient manner.
Package config has top-level configs etc.