Skip to content

Commit a000da9

Browse files
author
Thomas Miller
committed
Applying doc updates for readability.
- Change to the Dockerfile renaming the spec file to configuration.
1 parent 5e660c3 commit a000da9

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ RUN useradd -MrU conformance && \
2929

3030
EXPOSE 8080
3131
USER conformance
32-
ENTRYPOINT ["/app/entrypoint.sh", "rdap-spec.json"]
32+
ENTRYPOINT ["/app/entrypoint.sh", "rdap-configuration.json"]

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,35 +136,37 @@ For example:
136136
Docker
137137
------
138138

139-
RDAP conformance can be executed as a Docker container. The docker container
140-
works by having a spec file mounted into the containers file system. The
141-
return code of the container can be used to determine success or failure.
139+
`rdap-conformance` can be executed as a Docker container. The
140+
container works by having a test configuration file mounted into the
141+
container's file system. The return code of the container can be used
142+
to determine test success or failure.
142143

143144
### Building the image
144145

145-
The following command can be used to build an image.
146+
The following command can be used to build an image:
146147

147148
```
148149
docker build -t apnic/rdap-conformance .
149150
```
150151

151152
### Running the container
152153

153-
To run the Docker container.
154+
To run the Docker container:
154155

155156
```
156-
docker run -d -v "<path_to_spec.json>:/app/rdap-spec.json" \
157+
docker run -d -v "{configuration-path}:/app/rdap-configuration.json" \
157158
--name rdap-conformance apnic/rdap-conformance
158159
```
159160

160161
<aside class="notice">
161-
Its important to note the rdap-spec file must be mounted into the container as
162-
a file and not a directory.
162+
It's important to note that the configuration file must be mounted
163+
into the container as a file, not a directory.
163164
</aside>
164165

165166
### Accessing the return code of the container
166167

167-
The bellow command can be used to access the return code for the container.
168+
The below command can be used to access the return code for the
169+
container:
168170

169171
```
170172
docker wait rdap-conformance

0 commit comments

Comments
 (0)