TrueCloudLab/certificates
16
0
Fork 2
Code Issues 1 Pull requests 1 Releases Activity Actions

Amendments to CONTRIBUTING doc

Browse source
This commit is contained in:
Carl Tashian 2021-03-08 13:54:55 -08:00
parent c67531134a
commit 35be06f4aa
1 changed files with 38 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/CONTRIBUTING.md
View file

@ -29,15 +29,47 @@ To build from source:
Find your binaries in `bin/`.
### Alternative: Build a CGO `step-ca` (with PKCS#11 and YubiKey PIV support)
### Build `step-ca` using CGO
To build the CGO version of `step-ca` you will need [`go`](https://golang.org/), make, gcc, pkg-config, and the [`libpcsclite-dev`](https://pcsclite.apdu.fr/) package. On Ubuntu:
#### The CGO build enables PKCS #11 and YubiKey PIV support
sudo apt update
sudo apt install -y make gcc libpcsclite-dev pkg-config
To build the CGO version of `step-ca`, you will need [`go`](https://golang.org/), make, and a C compiler.
You'll also need PCSC support on your operating system, as required by the `go-piv` module.
On Linux, the [`libpcsclite-dev`](https://pcsclite.apdu.fr/) package provides PCSC support.
On macOS and Windows, PCSC support is built into the OS.
#### 1. Install PCSC support
On Debian-based distributions, run:
```shell
sudo apt-get install libpcsclite-dev
```
On Fedora:
```shell
sudo yum install pcsc-lite-devel
```
On CentOS:
```
sudo yum install 'dnf-command(config-manager)'
sudo yum config-manager --set-enabled PowerTools
sudo yum install pcsc-lite-devel
```
#### 2. Build `step-ca`
To build `step-ca`, clone this repository and run the following:
```shell
make bootstrap && make build GOFLAGS=""
```
Find your binaries in `bin/`.
When the build is complete, you will find binaries in `bin/`.
## Asking Support Questions