jashton/one-ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Josh Ashton
2024-11-06 19:30:21 -07:00
committed by GitHub
parent d98c6a19e4
commit e6ef5f9000
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -12
View File
@@ -42,19 +42,17 @@ The primary configuration file is located at `~/.config/one-ai/`. It is
recommended to keep two files, `test.json` and `live.json`. This is purely recommended to keep two files, `test.json` and `live.json`. This is purely
for security purposes. for security purposes.
The following are configurable parameters: The following are configurable parameters:<br>
- `text_model`: Specify the LLM used through Ollama, eg. "llama3". - `text_model`: Specify the LLM used through Ollama, eg. "llama3".<br>
- `response_stream`: `true` or `false`, to receive communication as it is - `response_stream`: `true` or `false`, to receive communication as it is
generated or once it is completed generating. generated or once it is completed generating.<br>
- `domain`: The URL to be used to access the router. - `domain`: The URL to be used to access the router.<br>
- `router_port`: The port to be exposed to the internet. - `router_port`: The port to be exposed to the internet.<br>
- `api`: The URL to be used to access the One AI API. - `api`: The URL to be used to access the One AI API.<br>
- `api_port`: A port to be only accessible to the localhost. - `api_port`: A port to be only accessible to the localhost.<br>
- `auth_port`: A port to be only accessible to the localhost. - `auth_port`: A port to be only accessible to the localhost.<br>
- `webpage_dir`: The directory containing a website. - `webpage_dir`: The directory containing a website.<br>
- `webpage_port`: The port to expose the webpage directory to the internet. - `webpage_port`: The port to expose the webpage directory to the internet.<br>
TODO: TODO:
Urgent: Urgent: