1. About

Hockeypuck is an OpenPGP public keyserver.

2. Latest Release

The latest release of Hockeypuck is 2.2.2.

Hockeypuck 2.x is a significant redesign of the original Hockeypuck 1.x, which is now deprecated. All bug fixes and new development will be on 2.x releases.

3. Features

3.1. OpenPGP Standards

Hockeypuck targets the HKP draft protocol specification. As this draft is a work in progress, Hockeypuck features may not exactly correspond to the current draft specification.

Public key material conforming to RFC 4880 is supported by the keyserver, as are RFC 6637 ECC keys. As-of-yet non-standard key material, such as v4 Ed25519 keys, may also be distributed by Hockeypuck.

3.2. SKS Reconciliation Protocol

Hockeypuck can synchronize public key material with SKS and other Hockeypuck servers. Recon protocol support is provided with the Conflux package.

3.3. Modular storage backend

Hockeypuck uses PostgreSQL ≥ 9.4 (tested up to v16) for storing indexed key material. The architecture supports additional storage backends, which must implement a simple set of Go interfaces.

3.4. Flexible rendering

Hockeypuck internally represents key material with an arbitrary document model that can be used with web applications by rendering it to JSON in responses. HTML responses can be customized by authoring a template that operates on the document model.

4. Install

Several options are available:

• Install with Docker (RECOMMENDED)
• Build and Install from source
• Install from tarball release (STALE)
• Install from Ubuntu archives (STALE)
• Deploy with Juju (STALE)

5. Next Steps

• Configuring a Hockeypuck server.
• Remotely administering a Hockeypuck server.
• Populating Hockeypuck with keyfiles.
• Dumping Hockeypuck database contents to keyfiles.
• Contributing to Hockeypuck. (STALE)
• Community support for Hockeypuck, for issues and new feature requests.

6. License

Copyright 2012-2024 Casey Marshall and the Hockeypuck contributors. Hockeypuck is distributed under the Affero GNU Public License, version 3.

In general, any use of Hockeypuck privately within an organization (including a company) is fine. Redistribution kicks in only when you publish services to other parties.

The AGPL license (and my intent in licensing it such) DOES NOT permit the following distribution scenarios:

• Distribute a closed-source application binary that builds with Hockeypuck AGPL packages. For example, a folder-syncing app that uses Conflux.
• Publishing a closed-source service that uses Hockeypuck in its deployment to other parties. The AGPL includes web API access as "distribution". For example, a PGP-based web service like keybase.io could be built with Hockeypuck, but it would be required to be open-source under the redistribution terms of the AGPL.

Contact me for licensing alternatives (or if you're still not quite sure).

Authors