Skip to content

docs: show proxy.conf.json in the client-only setup steps #454

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.

Sign up for GitHub

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

Merged
erkamyaman merged 1 commit into from
Nov 5, 2026
Merged

docs: show proxy.conf.json in the client-only setup steps #454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion apps/docs/src/content/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ An app created with `ng new --ssr=false` only runs `ng serve`. Run the standalon
Run <code>npx pangular dev --port 9999 --proxy-origin http://localhost:4200</code> from the root of your workspace. It serves the panel, the connection and the WebSocket at the root of port 9999. <code>--proxy-origin</code> names the origin of <code>ng serve</code>, so the CLI prints its links for <code>http://localhost:4200/__pangular/</code>.
</ngmd-step>
<ngmd-step title="Add the proxy config">
Save the <code>proxy.conf.json</code> above next to <code>angular.json</code>. It strips the <code>/__pangular</code> prefix, and <code>"ws": true</code> forwards the WebSocket the overlay and the panel connect over.
Save the <code>proxy.conf.json</code> below next to <code>angular.json</code>. It strips the <code>/__pangular</code> prefix, and <code>"ws": true</code> forwards the WebSocket the overlay and the panel connect over.
</ngmd-step>
<ngmd-step title="Point ng serve at it">
Set <code>proxyConfig</code> in the <code>serve</code> options of <code>angular.json</code>, or run <code>ng serve --proxy-config proxy.conf.json</code>.
Expand All @@ -253,6 +253,18 @@ An app created with `ng new --ssr=false` only runs `ng serve`. Run the standalon
</ngmd-step>
</ngmd-workflow>

Save this as `proxy.conf.json` next to `angular.json`:

```json
{
"/__pangular": {
"target": "http://localhost:9999",
"pathRewrite": {"^/__pangular": ""},
"ws": true
}
}
```

Point the dev server at the proxy file in `angular.json` (excerpt):

```json
Expand Down
Loading