diff --git a/docs/docs/92-development/03-ui.md b/docs/docs/92-development/03-ui.md index 1931ba99a..0c1ac3bc6 100644 --- a/docs/docs/92-development/03-ui.md +++ b/docs/docs/92-development/03-ui.md @@ -13,6 +13,15 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `pnpm start`. To enable the forwarding of requests to the UI server you have to enable the dev-proxy inside the Woodpecker server by adding `WOODPECKER_DEV_WWW_PROXY=http://localhost:8010` to your `.env` file. After starting the Woodpecker server as explained in the [debugging](./01-getting-started.md#debugging-woodpecker) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +### Usage with remote server + + If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: + +- `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` +- `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser + + Then, open the UI at `http://localhost:8010`. + ## Tools and frameworks The following list contains some tools and frameworks used by the Woodpecker UI. For some points we added some guidelines / hints to help you developing. diff --git a/docs/versioned_docs/version-3.9/92-development/03-ui.md b/docs/versioned_docs/version-3.9/92-development/03-ui.md index 1931ba99a..8186b63f3 100644 --- a/docs/versioned_docs/version-3.9/92-development/03-ui.md +++ b/docs/versioned_docs/version-3.9/92-development/03-ui.md @@ -13,6 +13,15 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `pnpm start`. To enable the forwarding of requests to the UI server you have to enable the dev-proxy inside the Woodpecker server by adding `WOODPECKER_DEV_WWW_PROXY=http://localhost:8010` to your `.env` file. After starting the Woodpecker server as explained in the [debugging](./01-getting-started.md#debugging-woodpecker) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +### Usage with remote server + +If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: + +- `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` +- `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser + +Then, open the UI at `http://localhost:8010`. + ## Tools and frameworks The following list contains some tools and frameworks used by the Woodpecker UI. For some points we added some guidelines / hints to help you developing.