docs: update online installation instruction #none
BIN
docs/images/change_space_params.png
Normal file
After Width: | Height: | Size: 209 KiB |
BIN
docs/images/close_logs_space.png
Normal file
After Width: | Height: | Size: 361 KiB |
BIN
docs/images/cohere_api_key.png
Normal file
After Width: | Height: | Size: 434 KiB |
BIN
docs/images/duplicate_space.png
Normal file
After Width: | Height: | Size: 369 KiB |
BIN
docs/images/initial_startup.png
Normal file
After Width: | Height: | Size: 268 KiB |
BIN
docs/images/set_api_key_space.png
Normal file
After Width: | Height: | Size: 315 KiB |
BIN
docs/images/space_build.png
Normal file
After Width: | Height: | Size: 216 KiB |
|
@ -5,11 +5,43 @@
|
||||||
This page is intended for **end users** who want to use the `kotaemon` tool for Question
|
This page is intended for **end users** who want to use the `kotaemon` tool for Question
|
||||||
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.
|
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.
|
||||||
|
|
||||||
## Download
|
## Installation (Online HuggingFace Space)
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>View instruction</summary>
|
||||||
|
|
||||||
|
1. Go to [kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template)
|
||||||
|
|
||||||
|
2. Use Duplicate function to create your own space
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
3. Wait for the build to complete and start up (apprx 10 mins).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
4. Follow the first setup instructions (and register for Cohere API key if needed)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
5. Complete the setup and use your own private space!
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## Installation (Offline)
|
||||||
|
|
||||||
|
### Download
|
||||||
|
|
||||||
Download the `kotaemon-app.zip` file from the [latest release](https://github.com/Cinnamon/kotaemon/releases/latest/).
|
Download the `kotaemon-app.zip` file from the [latest release](https://github.com/Cinnamon/kotaemon/releases/latest/).
|
||||||
|
|
||||||
## Installation
|
### Run setup script
|
||||||
|
|
||||||
0. Unzip the downloaded file.
|
0. Unzip the downloaded file.
|
||||||
1. Navigate to the `scripts` folder and start an installer that matches your OS:
|
1. Navigate to the `scripts` folder and start an installer that matches your OS:
|
||||||
|
|