From db6df22ec663ccd6dce5419a0c2ee52b8c31c3ef Mon Sep 17 00:00:00 2001 From: James Spurin Date: Thu, 16 Mar 2023 16:16:28 +0000 Subject: [PATCH] Update README.md Use the Makefile approach for pushing an image, it is cleaner and more reliable. This uses a builder reference to the default buildx-multi-arch reference, allowing the command to work as expected for those who have never used buildkit. Also, general formatting on README.md --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5702911..a57994e 100644 --- a/README.md +++ b/README.md @@ -7,33 +7,37 @@ The NGINX Docker Desktop Extension can be used to manage the instance configurat ## Development Before we can interactively develop the Extensions frontend, it must be installed first. -To build the extension locally. +To build the extension locally - ```shell docker build -t nginx/nginx-dd-extension . ``` -To install the extension +To install the extension - ```shell docker extension install nginx/nginx-dd-extension ``` -To remove the extension +To remove the extension - ```shell docker remove nginx/nginx-dd-extension ``` ## Release -```shell -docker buildx build --push --no-cache --platform=linux/amd64,linux/arm64 -t nginx/nginx-docker-extension:0.0.1 . +Use the provided Makefile to cross-compile and push an image that supports amd64 and arm64 architectures - + +``` +IMAGE=dockerhubid/nginx-dd-extension TAG=latest make push-extension ``` ### Start Docker Extension Development Server -1. start the UI node server in the `ui` directory. Make sure you install the dev dependencies at the first. +1. start the UI node server in the `ui` directory. Make sure you install the dev dependencies first - + ```shell npm install npm run dev ``` -2. enable debugging for the NGINX Docker Extension. +2. enable debugging for the NGINX Docker Extension - + ```shell docker extension dev debug nginx/nginx-dd-extension ``` @@ -65,4 +69,4 @@ docker run NEWIMAGE -p ... -p.... -v POSSIBLE MOUNTS Export configuration files from inside the container to a projects directory on the local computer ```shell docker cp CONTAINERID:/etc/nginx/conf.d/test.conf ./something/.... -``` \ No newline at end of file +```