diff --git a/README.md b/README.md index bd98936..47e1ab1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,13 @@ The project can be compiled using `go build`. This should create a binary which Alternatively, the `go run .` command can be used to automatically compile and run the project. -To run the tests, use `go test`. +To run the tests, use `go test ./...`. + +### Docker + +The CI builds a Docker image and pushes it to our Docker registry at `drp.codemoon.xopic.de`. In order to pull an image from the registry you have to login with `sudo docker login drp.codemoon.xopic.de`. Execute `sudo docker run -p 3000:3000 drp.codemoon.xopic.de/` to run the image locally. You can find the image name in the `dockerimage` CI job. You can then interact with the webserver on your local port 3000. + +You can also build the Docker image locally by executing `docker build -t .` in the root directory of this project. It assumes that the Go binary is named `poseidon` and available in the project root (see [here](#setup)). You can then start a Docker container with `sudo docker run --rm -p 3000:3000 `. ### Linter