letsencrypt
/
pebble
mirror of https://github.com/letsencrypt/pebble.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify github and go commands (#429) 

- Git/GitHub require a protocol (https://) for clone.
- For non-Go users it's non-obvious where pebble gets installed and
  how to get it into your $PATH so some guidance there is nice.
This commit is contained in:
zyphlar 2024-01-30 09:09:40 -08:00 committed by GitHub
parent d4a1be1ca3
commit 9966dd6622
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -66,22 +66,26 @@ correctly.
## Install
1. [Set up Go](https://golang.org/doc/install). Add ~/go/bin to your $PATH, or
set GOBIN to a directory that is in your $PATH already.
2. git clone github.com/letsencrypt/pebble/
3. cd pebble
4. go install ./cmd/pebble
1. [Set up Go](https://golang.org/doc/install)
2. Add `~/go/bin` to your $PATH, or set `GOBIN` to a directory that is in your
$PATH already, so that `pebble` will be in your $PATH for easy execution.
- One way to do this is to add `export PATH=$PATH:$HOME/go/bin` to your `~/.profile`
4. git clone https://github.com/letsencrypt/pebble/
5. cd pebble
6. go install ./cmd/pebble
## Usage
### Binary
Assuming pebble is in your $PATH:
Assuming pebble is easily accessible in your $PATH:
```bash
pebble -config ./test/config/pebble-config.json
```
(otherwise replace `pebble` with `~/go/bin/pebble` or `$GOBIN/pebble`)
Afterwards you can access the Pebble server's ACME directory
at `https://localhost:14000/dir`.