From 0e465d5fd615c2af773e456b8ec6f12da8c5159c Mon Sep 17 00:00:00 2001 From: Mohammed Abdul Hafeez Date: Mon, 24 Mar 2025 05:34:22 +0530 Subject: [PATCH] Updated the documentation for server host configuration settings --- docs/en/api/rspeedy/rspeedy.server.host.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/en/api/rspeedy/rspeedy.server.host.md b/docs/en/api/rspeedy/rspeedy.server.host.md index 948ca4734..0bdbf7db0 100644 --- a/docs/en/api/rspeedy/rspeedy.server.host.md +++ b/docs/en/api/rspeedy/rspeedy.server.host.md @@ -11,3 +11,20 @@ Specify the host that the Rspeedy Server listens to. ```typescript host?: string | undefined; ``` + +## Remarks + +By default, the server listens on local network IP, for example, `192.168.1.50`, verify your local net IP by the command `ifconfig` on your system for (en0 for MacOS and eth0 for LinuxOS users). In case you have multiple local network IP(s) particularly when you are running dockers on the host machine, then you can specify your desired host IP + +## Example + +Set the host to a custom value: + +```js +import { defineConfig } from '@lynx-js/rspeedy' +export default defineConfig({ + server: { + host: "192.168.1.50", + }, +}) +``` \ No newline at end of file