From dd935c96cfb444d8c2b59f5bd9f8db70ad457fc6 Mon Sep 17 00:00:00 2001 From: jaqb8 Date: Fri, 4 Aug 2023 14:44:14 +0200 Subject: [PATCH 1/4] Documentation update --- .changeset/eighty-hounds-juggle.md | 5 +++++ .../docs/25-build-and-deploy/40-adapter-node.md | 10 +++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .changeset/eighty-hounds-juggle.md diff --git a/.changeset/eighty-hounds-juggle.md b/.changeset/eighty-hounds-juggle.md new file mode 100644 index 000000000000..f892f01d4c04 --- /dev/null +++ b/.changeset/eighty-hounds-juggle.md @@ -0,0 +1,5 @@ +--- +'@sveltejs/kit': major +--- + +fix: added SOCKET_PATH env variable description in docs diff --git a/documentation/docs/25-build-and-deploy/40-adapter-node.md b/documentation/docs/25-build-and-deploy/40-adapter-node.md index 575c6b5296df..7745a0a2093a 100644 --- a/documentation/docs/25-build-and-deploy/40-adapter-node.md +++ b/documentation/docs/25-build-and-deploy/40-adapter-node.md @@ -49,7 +49,7 @@ npm install dotenv +node -r dotenv/config build ``` -### `PORT` and `HOST` +### `PORT`, `HOST` and `SOCKET_PATH` By default, the server will accept connections on `0.0.0.0` using port 3000. These can be customised with the `PORT` and `HOST` environment variables: @@ -57,6 +57,14 @@ By default, the server will accept connections on `0.0.0.0` using port 3000. The HOST=127.0.0.1 PORT=4000 node build ``` +Alternatively, the server can be configured to accept connections on a specified path. When this is done using the `SOCKET_PATH` environment variable, the `HOST` and `PORT` settings will be disregarded. + + + +``` +SOCKET_PATH=/tmp/socket node build +``` + ### `ORIGIN`, `PROTOCOL_HEADER` and `HOST_HEADER` HTTP doesn't give SvelteKit a reliable way to know the URL that is currently being requested. The simplest way to tell SvelteKit where the app is being served is to set the `ORIGIN` environment variable: From 6543bb937c02cd0f8ae4b92656e754663c875ab6 Mon Sep 17 00:00:00 2001 From: jaqb8 Date: Fri, 4 Aug 2023 15:09:35 +0200 Subject: [PATCH 2/4] Update changeset --- .changeset/eighty-hounds-juggle.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/eighty-hounds-juggle.md b/.changeset/eighty-hounds-juggle.md index f892f01d4c04..7842fd495fd5 100644 --- a/.changeset/eighty-hounds-juggle.md +++ b/.changeset/eighty-hounds-juggle.md @@ -1,5 +1,5 @@ --- -'@sveltejs/kit': major +'@sveltejs/kit': minor --- fix: added SOCKET_PATH env variable description in docs From 16b1c36e385c7a01cff16eb52a9efc6d0e99b3f5 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Thu, 10 Aug 2023 11:53:35 -0700 Subject: [PATCH 3/4] Update documentation/docs/25-build-and-deploy/40-adapter-node.md --- documentation/docs/25-build-and-deploy/40-adapter-node.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/documentation/docs/25-build-and-deploy/40-adapter-node.md b/documentation/docs/25-build-and-deploy/40-adapter-node.md index 7745a0a2093a..b333746a9944 100644 --- a/documentation/docs/25-build-and-deploy/40-adapter-node.md +++ b/documentation/docs/25-build-and-deploy/40-adapter-node.md @@ -59,8 +59,6 @@ HOST=127.0.0.1 PORT=4000 node build Alternatively, the server can be configured to accept connections on a specified path. When this is done using the `SOCKET_PATH` environment variable, the `HOST` and `PORT` settings will be disregarded. - - ``` SOCKET_PATH=/tmp/socket node build ``` From f07602e06c7f2702a17de863a64460c170fc0f49 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Thu, 10 Aug 2023 11:55:05 -0700 Subject: [PATCH 4/4] Update documentation/docs/25-build-and-deploy/40-adapter-node.md --- documentation/docs/25-build-and-deploy/40-adapter-node.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/25-build-and-deploy/40-adapter-node.md b/documentation/docs/25-build-and-deploy/40-adapter-node.md index b333746a9944..b377d07954b9 100644 --- a/documentation/docs/25-build-and-deploy/40-adapter-node.md +++ b/documentation/docs/25-build-and-deploy/40-adapter-node.md @@ -57,7 +57,7 @@ By default, the server will accept connections on `0.0.0.0` using port 3000. The HOST=127.0.0.1 PORT=4000 node build ``` -Alternatively, the server can be configured to accept connections on a specified path. When this is done using the `SOCKET_PATH` environment variable, the `HOST` and `PORT` settings will be disregarded. +Alternatively, the server can be configured to accept connections on a specified socket path. When this is done using the `SOCKET_PATH` environment variable, the `HOST` and `PORT` environment variables will be disregarded. ``` SOCKET_PATH=/tmp/socket node build