feat(docs): reverse proxy configuation

close #493
kestra-io · Sep 11, 2023 · e3b0ac8 · e3b0ac8 · vercel · Sep 11, 2023
1 parent 95281fe
commit e3b0ac8
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/...strator-guide/02.deployment/04.restack.md → ...r-guide/02.deployment/04.reverse-proxy.md b/...strator-guide/02.deployment/04.restack.md → ...r-guide/02.deployment/04.reverse-proxy.md
diff --git a/content/docs/09.administrator-guide/02.deployment/05.restack.md b/content/docs/09.administrator-guide/02.deployment/05.restack.md
@@ -0,0 +1,31 @@
+---
+title: Kestra behind a reverse proxy
+---
+
+If you prefer to host Kestra behind a reverse proxy, you should take care that Kestra use [https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events](Server Send Event (SSE)) to display execution in real-time.
+
+On some reverse proxy like Nginx, you need to disable buffering to enable real-time update.
+
+---
+
+## Nginx
+
+A working configuration is:
+```nginx
+location / {
+    proxy_pass  http://localhost:<kestra_port>;
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+    proxy_read_timeout 600s;
+    proxy_redirect    off;
+    proxy_set_header  Host             $http_host;
+    proxy_set_header  X-Real-IP        $remote_addr;
+    proxy_set_header  X-Forwarded-For  $proxy_add_x_forwarded_for;
+    proxy_set_header  X-Forwarded-Protocol $scheme;
+
+    # Needed for SSE
+    proxy_buffering off;
+    proxy_cache off;
+}
+```