Skip to content

Commit e0ef9a3

Browse files
authored
add bsetup notes to README (#8521)
- move `docker compose up` after the instructions about running tests - add `docker compose run bsetup` to the steps (@aarongable - I didn't feel like fixing my git mess, so i started over)
1 parent bfaa3d8 commit e0ef9a3

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,6 @@ We recommend having **at least 2GB of RAM** available on your Docker host. In
103103
practice using less RAM may result in the MariaDB container failing in
104104
non-obvious ways.
105105

106-
To start Boulder in a Docker container, run:
107-
108-
```shell
109-
docker compose up
110-
```
111-
112106
To run our standard battery of tests (lints, unit, integration):
113107

114108
```shell
@@ -152,6 +146,25 @@ represents a likely future state (e.g. including new feature flags):
152146
./tn.sh -your -options -here
153147
```
154148

149+
To start Boulder in a Docker container, first run:
150+
151+
```shell
152+
docker compose run bsetup
153+
```
154+
this will write the necessary certificates into `test/certs/[.softhsm-tokens,ipki,webpki]`;
155+
You only need to run this once to create the certificates. If you
156+
need to remove all of the certificates and start over, you can remove
157+
the directories `./test/certs/.softhsm-tokens`, `./test/certs/ipki`,
158+
and `./test/certs/webpki` and re-run `docker compose run bsetup`.
159+
160+
Then run:
161+
162+
```shell
163+
docker compose up
164+
```
165+
166+
167+
155168
The configuration in docker-compose.yml mounts your boulder checkout at
156169
/boulder so you can edit code on your host and it will be immediately
157170
reflected inside the Docker containers run with `docker compose`.

0 commit comments

Comments
 (0)