From 236cf89d7616827f67319312bbc4aa373adab0fe Mon Sep 17 00:00:00 2001 From: Jozef Kralik Date: Mon, 13 May 2024 09:33:05 +0000 Subject: [PATCH] update plgd bundle deployment --- content/en/docs/quickstart/contribute.md | 4 +++- content/en/docs/quickstart/deploy-plgd-hub.md | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/content/en/docs/quickstart/contribute.md b/content/en/docs/quickstart/contribute.md index fc551d97..fc7b8410 100644 --- a/content/en/docs/quickstart/contribute.md +++ b/content/en/docs/quickstart/contribute.md @@ -84,7 +84,9 @@ To automatically generate API clients and server stubs in golang protoc plugins go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest; go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest; go install google.golang.org/protobuf/cmd/protoc-gen-go@latest; -go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest +go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest; +go install github.com/favadi/protoc-go-inject-tag@latest; +go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest; ``` ### Instal yq to set up environment diff --git a/content/en/docs/quickstart/deploy-plgd-hub.md b/content/en/docs/quickstart/deploy-plgd-hub.md index 964c0fe8..3b2af0d0 100644 --- a/content/en/docs/quickstart/deploy-plgd-hub.md +++ b/content/en/docs/quickstart/deploy-plgd-hub.md @@ -30,10 +30,11 @@ Bundle version of plgd services should be used only for simple testing and devel To deploy and access plgd hub on your local PC using bundle, run single command: ```bash -docker run -d --name plgd -p 443:443 -p 5683:5683 -p 5684:5684 ghcr.io/plgd-dev/hub/bundle:latest +docker run -d --name plgd -e FQDN=localhost -p 443:443 -p 5683:5683 -p 5684:5684 ghcr.io/plgd-dev/hub/bundle:latest ``` -After couple of seconds your plgd hub will become available. The plgd dashboard can be opened in your browser at [https://localhost/](https://localhost/). +After a couple of seconds, your plgd hub will become available. The plgd dashboard can be opened in your browser at [https://localhost/](https://localhost/). To customize the domain or IP, set the FQDN using `-e FQDN=yourdomain.com` or `-e FQDN=IP`. + >Note that bundle issues it's own **self-signed certificate** which needs to be accepted in the browser. ### Authorization