Skip to content

Commit 7da3d86

Browse files
authored
Merge pull request #30 from reload/doc-storybook
Add Storybook documentation
2 parents dd36d98 + 97b5f42 commit 7da3d86

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ This nginx proxy comes with three predefined configurations:
7272

7373
- Proxy
7474
- Next.js
75+
- Storybook
7576
- Drupal
7677

7778
### Proxy
@@ -80,7 +81,7 @@ Proxy is a generic configuration that just forwards requests to the
8081
backend.
8182

8283
```yaml
83-
image: ghcr.io/arnested/https-proxy:proxy
84+
image: ghcr.io/reload/https-proxy:proxy
8485
```
8586

8687
See the configuration details in
@@ -100,7 +101,7 @@ Next.js is like the proxy configuration but also forwards WebSocket
100101
connections on the path `/_next/webpack-hmr`.
101102

102103
```yaml
103-
image: ghcr.io/arnested/https-proxy:nextjs
104+
image: ghcr.io/reload/https-proxy:nextjs
104105
```
105106

106107
See the configuration details in
@@ -114,13 +115,34 @@ environment:
114115
NGINX_PROXY_PASS: http://app:3000
115116
```
116117

118+
### Storybook
119+
120+
Storybook is like the proxy configuration but also forwards WebSocket
121+
connections on the paths `/__webpack-hmr` and
122+
`/storybook-server-channel`.
123+
124+
```yaml
125+
image: ghcr.io/reload/https-proxy:storybook
126+
```
127+
128+
See the configuration details in
129+
[`context/storybook/etc/nginx/templates/default.conf.template`](context/storybook/etc/nginx/templates/default.conf.template).
130+
131+
Use can use the following configuration in your `docker-compose.yml`:
132+
133+
```yaml
134+
environment:
135+
NGINX_DOCUMENT_ROOT: /var/www/web
136+
NGINX_PROXY_PASS: http://app:6006
137+
```
138+
117139
### Drupal
118140

119141
Drupal is a configuration that forwards requests to a Drupal
120142
development server.
121143

122144
```yaml
123-
image: ghcr.io/arnested/https-proxy:drupal
145+
image: ghcr.io/reload/https-proxy:drupal
124146
```
125147

126148
See the configuration details in
@@ -142,7 +164,7 @@ There is also a base configuration that comes with no predefined
142164
configuration.
143165

144166
```yaml
145-
image: ghcr.io/arnested/https-proxy:base
167+
image: ghcr.io/reload/https-proxy:base
146168
```
147169

148170
You can add your own configuration by mounting a volume to
@@ -162,5 +184,6 @@ include include.d/ssl.conf;
162184
> which we have used for most of our projects.
163185
>
164186
> The new approach is smaller (due to using nginx), more inline with
165-
> current production hosting practice (nginx, again), also supports
166-
> Next.js, and should be easier to maintain and keep up-to-date.
187+
> current production hosting practice (nginx, again), should be easier
188+
> to maintain and keep up-to-date, and also supports Next.js,
189+
> Storybook, and generic proxies.

0 commit comments

Comments
 (0)