-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1691 from janhq/docs/v1.0.3-docs
Docs/v1.0.3 docs CORS
- Loading branch information
Showing
5 changed files
with
190 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: Cortex Config | ||
| description: Cortex config command | ||
| slug: "config" | ||
| --- | ||
|
|
||
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| # `cortex config` | ||
|
|
||
| This command allows you to update server configurations such as CORS and Allowed Headers. | ||
|
|
||
| ## Usage | ||
| :::info | ||
| You can use the `--verbose` flag to display more detailed output of the internal processes. To apply this flag, use the following format: `cortex --verbose [subcommand]`. | ||
| ::: | ||
|
|
||
| <Tabs> | ||
| <TabItem value="MacOs/Linux" label="MacOs/Linux"> | ||
| ```sh | ||
| cortex config [options] [subcommand] | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="Windows" label="Windows"> | ||
| ```sh | ||
| cortex.exe config [options] [subcommand] | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| **Options**: | ||
|
|
||
| | Option | Description | Required | Default value | Example | | ||
| |------------------|-------------------------------------------|----------|----------------------|---------| | ||
| | `--cors` | Toggle CORS | No | true | `on`, `off` | | ||
| | `--allowed_origins`| Allowed origins for CORS | No | `http://localhost:39281`, `http://127.0.0.1:39281` | `http://localhost:3000` | | ||
| | `-h`, `--help` | Display help information for the command. | No | - | `-h` | | ||
|
|
||
| --- | ||
| # Subcommands: | ||
|
|
||
| ## `cortex config status` | ||
| :::info | ||
| This CLI command calls the following API endpoint: | ||
| - [Get Configurations](/api-reference#tag/configurations/get/v1/configs) | ||
| ::: | ||
| This command returns all server configurations. | ||
|
|
||
| **Usage**: | ||
| <Tabs> | ||
| <TabItem value="MacOs/Linux" label="MacOs/Linux"> | ||
| ```sh | ||
| cortex config status | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="Windows" label="Windows"> | ||
| ```sh | ||
| cortex.exe config status | ||
|
|
||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| For example, it returns the following: | ||
|
|
||
| ``` | ||
| +-------------------------------------------------------------------------------------+ | ||
| | Config name | Value | | ||
| +-------------------------------------------------------------------------------------+ | ||
| | allowed_origins | http://localhost:39281 | | ||
| +-------------------------------------------------------------------------------------+ | ||
| | allowed_origins | http://127.0.0.1:39281/ | | ||
| +-------------------------------------------------------------------------------------+ | ||
| | cors | true | | ||
| +-------------------------------------------------------------------------------------+ | ||
| ``` |
Oops, something went wrong.