Skip to content

docs(cli): add --bind flag documentation for server start command #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
foyzulkarim wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

docs(cli): add --bind flag documentation for server start command #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions 3_cli/1_serve/server-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ The `lms server start` command launches the LM Studio local server, allowing you
type: "flag"
optional: true
description: "Enable CORS support for web application development. When not set, CORS is disabled"
- name: "--bind"
type: "string"
optional: true
description: "Bind address for the server. Use '0.0.0.0' to accept connections from the network. Defaults to localhost only"
```

## Start the server
Expand Down Expand Up @@ -45,6 +49,15 @@ lms server start --cors

Note that enabling CORS may expose your server to security risks, so use it only when necessary.

### Serve on local network

To make the server accessible from other devices on your local network:
```shell
lms server start --bind 0.0.0.0
```

**Warning:** This will accept connections from any device on your network. Only use this if you understand the security implications.

### Check the server status

See [`lms server status`](/docs/cli/serve/server-status) for more information on checking the status of the server.