From 64e18c642fdf8d03f28ffb65e52f1b1cb7443e95 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arne=20J=C3=B8rgensen?= <arne@arnested.dk>
Date: Thu, 28 Nov 2024 09:29:26 +0100
Subject: [PATCH] Add Storybook documentation

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 40868fa..a3f8615 100644
--- a/README.md
+++ b/README.md
@@ -72,6 +72,7 @@ This nginx proxy comes with three predefined configurations:
 
 - Proxy
 - Next.js
+- Storybook
 - Drupal
 
 ### Proxy
@@ -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
@@ -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.