pebble icon indicating copy to clipboard operation
pebble copied to clipboard

Documentation: mention that when using with release binary, you should copy the test folder

Open aral opened this issue 4 years ago • 1 comments

When I first tried to get Pebble running using the binary I downloaded from the releases, it complained about missing files it was looking for. I got it working by copying the test directory from the source repository into the same folder as the Pebble binary. With that, I was able to run Pebble without needing to specify any arguments.

This would be useful to document for people just starting out with Pebble to improve their initial experience.

Related: #308

aral avatar Apr 05 '20 15:04 aral

@aral: I got it working by copying the test directory from the source repository into the same folder as the Pebble binary. With that, I was able to run Pebble without needing to specify any arguments.

Hi @aral,

I glanced at the current code and it appears there is a default setting for the config file location applied:

https://github.com/letsencrypt/pebble/blob/05f79ba495ab6a27cbbc32e20b44afac52eb9914/cmd/pebble/main.go#L33-L36

This appears to explain why having the test data alongside the downloaded binary did not require you to explicitly reference the configuration file.


The current example has you installing the binary from source and then remaining in the directory where you ran go install for the next step, which is pebble -config ./test/config/pebble-config.json; the local path reference assumes that your current working directory is still $GOPATH/src/github.com/letsencrypt/pebble.

If you're following those steps exactly that is true, but as you indicate it could probably be called out to make it clearer.

Some thoughts that come to mind:

  • flesh out a subsection specific to the release binaries with a note regarding copying the test data
  • bundle the test data alongside release binaries in an archive file (along with any other core requirements)

It might be worth discussing the latter approach alongside any work to update the README.

I've only recently looked into this project, so my apologies if I am off-base on my feedback.

atc0005 avatar Jul 26 '20 11:07 atc0005