[PATCH datacenter-manager v2] ui: adjust testing description

[PATCH datacenter-manager v2] ui: adjust testing description

[Dominik Rusovac]

Describe how to use trunk server for testing.

Signed-off-by: Dominik Rusovac <d.rusovac@proxmox.com>
---
 changes since v1:
 * adjusted wording
 * added PDM acronym
 * added introduction with high-level description

 ui/README.md | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

diff --git a/ui/README.md b/ui/README.md
index f083ea5..ec9b9d4 100644
--- a/ui/README.md
+++ b/ui/README.md
@@ -1,21 +1,18 @@
-# Experimental Yew GUI for Proxmox Datacenter Manager
+# Experimental Yew GUI for Proxmox Datacenter Manager (PDM)
 
 # Testing
 
-1.) start datacenter manager
+For testing changes in the web UI with rapid development workflow, we recommend to:
 
-sudo ./target/debug/proxmox-datacenter-privileged-api
-sudo -u www-data ./target/debug/proxmox-datacenter-api 
+1. run a PDM daemon, which can be done on a virtual machine or an existing instance; and
+2. use [trunk](https://github.com/trunk-rs/trunk), which builds the web UI upon changes and proxies API calls to the PDM daemon, so the frontend can talk to the PDM during development.
 
-2.) either: start local trunk server
+Assuming PDM is reachable via 172.16.254.1:8443.
 
- trunk serve --proxy-backend=https://localhost:8443/api2/ --proxy-insecure
+To test on http://localhost:8080, use:
 
- then test with url: http://localhost:8080
+    trunk serve --proxy-backend=https://172.16.254.1:8443/api2/ --proxy-insecure
 
-2.) or: copy files into pdm js folder:
+To test elsewhere with a secure connection, say https://dev:8080/, generate a cert to obtain `api.key` and `api.pem`, and use:
 
-    make all
-    make install
-
-And test with url https://localhost:8443
+    trunk serve --address 0.0.0.0 --serve-base / --proxy-backend https://172.16.254.1:8443/api2/ --public-url https://dev:8080/ --proxy-insecure --tls-key-path api.key --tls-cert-path api.pem
-- 
2.47.3

Re: [PATCH datacenter-manager v2] ui: adjust testing description

[Maximiliano Sandoval]

Dominik Rusovac <d.rusovac@proxmox.com> writes:

> Describe how to use trunk server for testing.
>
> Signed-off-by: Dominik Rusovac <d.rusovac@proxmox.com>
> ---
>  changes since v1:
>  * adjusted wording
>  * added PDM acronym
>  * added introduction with high-level description
>
>  ui/README.md | 21 +++++++++------------
>  1 file changed, 9 insertions(+), 12 deletions(-)
>
> diff --git a/ui/README.md b/ui/README.md
> index f083ea5..ec9b9d4 100644
> --- a/ui/README.md
> +++ b/ui/README.md
> @@ -1,21 +1,18 @@
> -# Experimental Yew GUI for Proxmox Datacenter Manager
> +# Experimental Yew GUI for Proxmox Datacenter Manager (PDM)
>  
>  # Testing
>  
> -1.) start datacenter manager
> +For testing changes in the web UI with rapid development workflow, we recommend to:
>  
> -sudo ./target/debug/proxmox-datacenter-privileged-api
> -sudo -u www-data ./target/debug/proxmox-datacenter-api 
> +1. run a PDM daemon, which can be done on a virtual machine or an existing instance; and
> +2. use [trunk](https://github.com/trunk-rs/trunk), which builds the web UI upon changes and proxies API calls to the PDM daemon, so the frontend can talk to the PDM during development.
>  
> -2.) either: start local trunk server
> +Assuming PDM is reachable via 172.16.254.1:8443.
>  
> - trunk serve --proxy-backend=https://localhost:8443/api2/ --proxy-insecure
> +To test on http://localhost:8080, use:
>  
> - then test with url: http://localhost:8080
> +    trunk serve --proxy-backend=https://172.16.254.1:8443/api2/ --proxy-insecure
>  
> -2.) or: copy files into pdm js folder:
> +To test elsewhere with a secure connection, say https://dev:8080/, generate a cert to obtain `api.key` and `api.pem`, and use:
>  
> -    make all
> -    make install
> -
> -And test with url https://localhost:8443
> +    trunk serve --address 0.0.0.0 --serve-base / --proxy-backend https://172.16.254.1:8443/api2/ --public-url https://dev:8080/ --proxy-insecure --tls-key-path api.key --tls-cert-path api.pem

Looks good to me, thanks!

Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>

-- 
Maximiliano