Skip to content

Commit

Permalink
Clarify github and go commands (#429)
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
zyphlar authored Jan 30, 2024
1 parent d4a1be1 commit 9966dd6
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit 9966dd6

Please sign in to comment.