Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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/....
```
```