cloudflare/privacypass-config

cloudflare/privacypass-config

Description: Development and deployment CLI for Cloudflare Privacy Pass implementation

Language: TypeScript

License: NOASSERTION

Stars: 11

Forks: 1

Open issues: 1

Created: 2024-01-02T19:12:32Z

Pushed: 2026-05-08T19:44:31Z

Default branch: main

Fork: no

Archived: no

README:

privacypass-config

This service allows you to start a Privacy Pass stack locally: an attester, an origin, and an issuer. It leverages Cloudflare repositories.

Quick start

With node.js 20+

• Install

npm install

• Develop

npm run start -- dev --config ./examples/git.config.yaml

• Deploy

npm run start -- deploy --config ./examples/git.config.yaml --service issuer

• Test end-to-end (only support issuer)

npm run start -- test --config ./examples/testE2E.config.yaml --service issuer

Config

Example config files are available in [./examples](./examples). You need to place one in the root folder with the name config.yaml. For instance, cp examples/git.config.yaml config.yaml.

The configuration can be a file, a url, or a git. In the case of a file or a git, the local port can be specified.

services:
attester:
git: "https://github.com/cloudflare/privacypass-attester"
port: "8788"
issuer:
url: "https://pp-issuer-public.research.cloudflare.com"
origin:
file: "./privacypass-origin"
port: "8789"

config:
directory: "dist"

Features

• Load the above yaml configuration
• Clone repos if they don't exist
• Start services on their respective port. This imply configuring them if needed (issuer needs a key rotation at start)

Next features

• Started privacypass-browser-extension in a headless browser