feat: add new allowedHosts option

withastro · Feb 20, 2025 · 7e674ad · 7e674ad
1 parent 3842ce5
commit 7e674ad
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 2 deletions.
diff --git a/.changeset/grumpy-sloths-fail.md b/.changeset/grumpy-sloths-fail.md
@@ -0,0 +1,28 @@
+---
+'astro': minor
+---
+
+Adds a new option in the config called `server.allowedHosts` and CLI option called `--allowed-hosts`.
+
+This new options allows to specify the hostnames that the dev server and preview server are allowed to respond to
+
+```shell
+astro dev --allowed-hosts=foo.bar.example.com,bar.example.com
+```
+
+```shell
+astro preview --allowed-hosts=foo.bar.example.com,bar.example.com
+```
+
+```js
+// astro.config.mjs
+import {defineConfig} from "astro/config";
+
+export default defineConfig({
+  server: {
+    allowedHosts: ['foo.bar.example.com', 'bar.example.com']
+  }
+})
+```
+
+More information are available in the [vite documentation](https://vite.dev/config/server-options.html#server-allowedhosts).
diff --git a/packages/astro/src/cli/dev/index.ts b/packages/astro/src/cli/dev/index.ts
@@ -20,6 +20,7 @@ export async function dev({ flags }: DevOptions) {
 					['--host <custom-address>', `Expose on a network IP address at <custom-address>`],
 					['--open', 'Automatically open the app in the browser on server start'],
 					['--force', 'Clear the content layer cache, forcing a full rebuild.'],
+					['--allowed-hosts', 'Specify a comma-separated list of allowed hosts.'],
 					['--help (-h)', 'See all available flags.'],
 				],
 			},

diff --git a/packages/astro/src/cli/flags.ts b/packages/astro/src/cli/flags.ts
@@ -25,6 +25,12 @@ export function flagsToAstroInlineConfig(flags: Flags): AstroInlineConfig {
 				typeof flags.host === 'string' || typeof flags.host === 'boolean' ? flags.host : undefined,
 			open:
 				typeof flags.open === 'string' || typeof flags.open === 'boolean' ? flags.open : undefined,
+			allowedHosts:
+				typeof flags.allowedHosts === 'string'
+					? flags.allowedHosts.split(',')
+					: typeof flags.allowedHosts === 'boolean' && flags.allowedHosts === true
+						? flags.allowedHosts
+						: [],
 		},
 	};
 }

diff --git a/packages/astro/src/cli/preview/index.ts b/packages/astro/src/cli/preview/index.ts
@@ -18,6 +18,7 @@ export async function preview({ flags }: PreviewOptions) {
 					['--host', `Listen on all addresses, including LAN and public addresses.`],
 					['--host <custom-address>', `Expose on a network IP address at <custom-address>`],
 					['--open', 'Automatically open the app in the browser on server start'],
+					['--allowed-hosts', 'Specify a comma-separated list of allowed hosts.'],
 					['--help (-h)', 'See all available flags.'],
 				],
 			},

diff --git a/packages/astro/src/core/config/schema.ts b/packages/astro/src/core/config/schema.ts
@@ -77,6 +77,7 @@ export const ASTRO_CONFIG_DEFAULTS = {
 		host: false,
 		port: 4321,
 		open: false,
+		allowedHosts: []
 	},
 	integrations: [],
 	markdown: markdownConfigDefaults,
@@ -214,6 +215,7 @@ export const AstroConfigSchema = z.object({
 					.default(ASTRO_CONFIG_DEFAULTS.server.host),
 				port: z.number().optional().default(ASTRO_CONFIG_DEFAULTS.server.port),
 				headers: z.custom<OutgoingHttpHeaders>().optional(),
+				allowedHosts: z.union([z.array(z.string()), z.literal(true)]).optional().default(ASTRO_CONFIG_DEFAULTS.server.allowedHosts),
 			})
 			.default({}),
 	),

diff --git a/packages/astro/src/core/dev/container.ts b/packages/astro/src/core/dev/container.ts
@@ -56,7 +56,7 @@ export async function createContainer({
 
 	const {
 		base,
-		server: { host, headers, open: serverOpen },
+		server: { host, headers, open: serverOpen, allowedHosts },
 	} = settings.config;
 
 	// serverOpen = true, isRestart = false
@@ -92,7 +92,7 @@ export async function createContainer({
 	const mode = inlineConfig?.mode ?? 'development';
 	const viteConfig = await createVite(
 		{
-			server: { host, headers, open },
+			server: { host, headers, open, allowedHosts },
 			optimizeDeps: {
 				include: rendererClientEntries,
 			},

diff --git a/packages/astro/src/core/preview/static-preview-server.ts b/packages/astro/src/core/preview/static-preview-server.ts
@@ -36,6 +36,7 @@ export default async function createStaticPreviewServer(
 				port: settings.config.server.port,
 				headers: settings.config.server.headers,
 				open: settings.config.server.open,
+				allowedHosts: settings.config.server.allowedHosts
 			},
 			plugins: [vitePluginAstroPreview(settings)],
 		});

diff --git a/packages/astro/src/types/public/config.ts b/packages/astro/src/types/public/config.ts
@@ -95,6 +95,26 @@ export type ServerConfig = {
 	 * ```
 	 */
 	open?: string | boolean;
+
+	/**
+	 * @name server.allowedHosts
+	 * @type {string[] | true}
+	 * @default `false`
+	 * @version 5.4.0
+	 * @description
+	 * 
+	 * A list of hostnames that Astro is allowed to respond to. When the value is set to `true`, any 
+	 * hostname is allowed. 
+	 *
+	 * ```js
+	 * {
+	 *   server: { 
+	 *   	allowedHosts: ['staging.example.com', 'qa.example.com']
+	 *   }
+	 * }
+	 * ```
+	 */
+	allowedHosts?: string[] | boolean;
 };
 
 export type SessionDriverName = BuiltinDriverName | 'custom' | 'test';