From 690a117ffd28b0d12e9b56a0e864f2c1b77517b8 Mon Sep 17 00:00:00 2001 From: Jeff Leung Date: Sun, 14 Jan 2024 00:08:14 -0800 Subject: [PATCH] Update README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a546f55..d1c8f00 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,8 @@ To build and run the application, follow these steps: 4. Run the command `dotnet build` to build the application. This will compile the source code and prepare it for execution. 5. After a successful build, you can start the application by running `dotnet run`. 6. The application will start, and you can access the endpoints as specified. -### Building a Docker Image for the MVC Version + +## Building a Docker Image ### Building a Docker Image for the Minimal API Version @@ -88,6 +89,14 @@ To containerize the `AS1024.GeoFeed.MinimalAPI` version using Docker, you can fo Ensure you have Docker installed and configured on your machine before executing this command. This Docker image can then be used to deploy the application in containerized environments such as Kubernetes or Docker Compose setups. +## Docker Deployment + +To deploy the Docker container of this GeoFeed application, simply pull the image for the following variants: + +- MVC Variant ``docker pull git.startmywifi.com/as1024/geofeed:latest`` +- Minimal API Variant ``docker pull git.startmywifi.com/as1024/geofeed:aot-minimal`` + +To configure the container, please refer to the Configuration section above. You should be able to configure this with either an environment variable or map an ``appSettings.json`` file to the container. ## Endpoints