Skip to content

Commit f0e3121

Browse files
author
Thomas Miller
committed
Added Docker documentation to README.md
1 parent 6a09b26 commit f0e3121

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,39 @@ For example:
136136
Docker
137137
------
138138

139-
Docker section
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.
142+
143+
### Building the image
144+
145+
The following command can be used to build an image.
146+
147+
```
148+
docker build -t apnic/rdap-conformance .
149+
```
150+
151+
### Running the container
152+
153+
To run the Docker container.
154+
155+
```
156+
docker run -d -v "<path_to_spec.json>:/app/rdap-spec.json"
157+
--name rdap-conformance apnic/rdap-conformance
158+
```
159+
160+
<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.
163+
</aside>
164+
165+
### Accessing the return code of the container
166+
167+
The bellow command can be used to access the return code for the container.
168+
169+
```
170+
docker wait rdap-conformance
171+
```
140172

141173
License
142174
-------

0 commit comments

Comments
 (0)