Skip to content

Commit

Permalink
Add Storybook documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arnested committed Nov 28, 2024
1 parent dd36d98 commit 64e18c6
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ This nginx proxy comes with three predefined configurations:

- Proxy
- Next.js
- Storybook
- Drupal

### Proxy
Expand Down Expand Up @@ -114,6 +115,27 @@ environment:
NGINX_PROXY_PASS: http://app:3000
```

### Storybook

Storybook is like the proxy configuration but also forwards WebSocket
connections on the paths `/__webpack-hmr` and
`/storybook-server-channel`.

```yaml
image: ghcr.io/reload/https-proxy:storybook
```

See the configuration details in
[`context/storybook/etc/nginx/templates/default.conf.template`](context/storybook/etc/nginx/templates/default.conf.template).

Use can use the following configuration in your `docker-compose.yml`:

```yaml
environment:
NGINX_DOCUMENT_ROOT: /var/www/web
NGINX_PROXY_PASS: http://app:6006
```

### Drupal

Drupal is a configuration that forwards requests to a Drupal
Expand Down Expand Up @@ -162,5 +184,6 @@ include include.d/ssl.conf;
> which we have used for most of our projects.
>
> The new approach is smaller (due to using nginx), more inline with
> current production hosting practice (nginx, again), also supports
> Next.js, and should be easier to maintain and keep up-to-date.
> current production hosting practice (nginx, again), should be easier
> to maintain and keep up-to-date, and also supports Next.js,
> Storybook, and generic proxies.

0 comments on commit 64e18c6

Please sign in to comment.