Skip to content

Commit

Permalink
docs: enhance content
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Feb 16, 2024
1 parent e7722e4 commit 8f07ee3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
14 changes: 8 additions & 6 deletions docs/docs/guides/05-using-server/01-start-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ keywords:
conversational AI,
no-subscription fee,
large language model,
local server,
api server,
]
---

Expand All @@ -23,19 +25,19 @@ Navigate by clicking the `Local API Server` icon on the left side of your screen

<br></br>

![01-local-api-view](./assets/01-local-api-view.png)
![01-local-api-view](./assets/01-local-api-view.gif)

## Choose your model
## Choosing a Model

On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`.

<br></br>

![01-choose-model](./assets/01-choose-model.png)

## Set your Server Options
## Server Options

On the left side of your screen you can set custom server options.
On the left side of your screen, you can set custom server options.

<br></br>

Expand All @@ -49,9 +51,9 @@ You can make the local server more accessible by clicking on the address and cho

### Port

Jan runs on port `1337` by default, but this can be changed.
Jan runs on port `1337` by default. You can change the port to any other port number if needed.

### CORS
### Cross-Origin Resource Sharing (CORS)

Cross-Origin Resource Sharing (CORS) manages resource access on the local server from external domains. Enabled for security by default, it can be disabled if needed.

Expand Down
4 changes: 3 additions & 1 deletion docs/docs/guides/05-using-server/02-using-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ keywords:
conversational AI,
no-subscription fee,
large language model,
local server,
api server,
]
---

Expand Down Expand Up @@ -40,7 +42,7 @@ With your local server running, you can click the `Try it out` button on the top

Use the API endpoints, request and response body examples as models for your own application.

### Curl request example
### cURL Request Example

Here's an example curl request with a local server running `tinyllama-1.1b`:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.

0 comments on commit 8f07ee3

Please sign in to comment.