Skip to content

Commit 4cb6497

Browse files
committed
review feedback
- remove example error messages - move instructions for running a local boulder server to its own section at the end - `docker compose run` != `docker compose up` and `run` is better for `bsetup`
1 parent 57b7dd2 commit 4cb6497

File tree

1 file changed

+16
-29
lines changed

1 file changed

+16
-29
lines changed

README.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -106,41 +106,20 @@ non-obvious ways.
106106
Before starting Boulder for the first time, run:
107107

108108
```shell
109-
docker compose up bsetup
109+
docker compose run bsetup
110110
```
111-
this will write the necessary certificates into `test/certs/[.softhsm-tokens,ipki,webpki]`;
112-
if you don't do this, you will get errors like:
111+
this will write the necessary certificates into
112+
`test/certs/[.softhsm-tokens,ipki,webpki]`; you only need to run this
113+
once to create the certificates. If you need to remove all of the
114+
certificates and start over, you can remove the directories
115+
`./test/certs/.softhsm-tokens`, `./test/certs/ipki`, and
116+
`./test/certs/webpki` and re-run `docker compose run bsetup`.
113117

114-
```shell
115-
bconsul-1 | ==> Failed to load cert/key pair: open test/certs/ipki/consul.boulder/cert.pem: no such file or directory
116-
[...]
117-
bconsul-1 exited with code 1
118-
[...]
119-
boulder-1 | Error querying DNS. Is consul running? `docker compose ps bconsul`. [Errno -3] Temporary failure in name resolution
120-
```
121-
You only need to run this once to create the certificates. If you
122-
need to remove all of the certificates and start over, you can remove
123-
the directories `./test/certs/.softhsm-tokens`, `./test/certs/ipki`,
124-
and `./test/certs/webpki` and re-run `docker compose up bsetup`.
125-
126-
To start Boulder in a Docker container, run:
127-
128-
```shell
129-
docker compose up
130-
```
131-
132-
To run our standard battery of tests (lints, unit, integration), first
133-
type `docker compose down` to stop the running Boulder containers if you
134-
started them as instructed above, then type:
118+
To run our standard battery of tests (lints, unit, integration) type:
135119

136120
```shell
137121
./t.sh
138122
```
139-
If you don't do this, you will get errors like:
140-
141-
```shell
142-
Error response from daemon: failed to set up container networking: Address already in use
143-
```
144123

145124
To run all unit tests:
146125

@@ -238,6 +217,14 @@ Run integration tests (omit `--filter <REGEX>` to run all):
238217
docker compose run --use-aliases boulder python3 test/integration-test.py --chisel --gotest --filter <REGEX>
239218
```
240219

220+
### Starting a local Boulder server
221+
222+
To start Boulder in a Docker container, run:
223+
224+
```shell
225+
docker compose up
226+
```
227+
241228
### Working with Certbot
242229

243230
Check out the Certbot client from https://github.com/certbot/certbot and

0 commit comments

Comments
 (0)